List Report Requests

GET 
/report/

Request

Query Parameters

length integer

Number of results to return per page.

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

search string

A search term.

Responses

200

application/json

Schema

Schema

count integer

Total number of results.

page_total integer

Total number of pages.

page integer

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integer

Number of results returned per page.

results

object[]

Array [

id stringrequired

A unique Base58 value identifying this object.

user stringrequired

A unique Base58 value identifying this object.

submitted_at date-timerequired

Date and time of the report submission date, in ISO 8601 UTC format.
For example, '2023-08-09T13:27.43.8208302'

generated_at date-timenullablerequired

Date and time when the report file was generated, in ISO 8601 UTC format.
For example, '2023-08-09T13:27.43.8208302'

is_email_notification_enabled boolean

If true, email notifications are enabled, and the report will be sent to the user via email. If false, email notifications are disabled. Defaults to false.

filters stringrequired

A unique Base58 value identifying this object.

ttl stringrequired

The time-to-live (TTL) for the report file, indicating how long it remains available.

timezone string

Possible values: <= 64 characters

Time zone name according to the IANA standard (e.g., 'America/New_York', 'Europe/London').

]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "user": "string",
      "submitted_at": "2024-07-29T15:51:28.071Z",
      "generated_at": "2024-07-29T15:51:28.071Z",
      "is_email_notification_enabled": true,
      "filters": "string",
      "ttl": "string",
      "timezone": "string"
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...