Report Generation Status

GET 
/report/:id/status/

Returns 200 if report generation is complete or 202 if report generation is still in progress.

Request

Path Parameters

id stringrequired

Responses

200

application/json

Schema

Schema

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)

{
  "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"
}

202

application/json

Schema

Schema

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)

{
  "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...