Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Reports

Partial Update to Report Request

patch/report/{id}/

Path parameters

idstring required

A unique Base58 value identifying this object.

Request body

idstring

A unique Base58 value identifying this object.

userstring

A unique Base58 value identifying this object.

submitted_atstring date-time

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

generated_atstring date-time nullable

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_enabledboolean

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.

filtersstring

A unique Base58 value identifying this object.

ttlstring

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

timezonestring

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

Response

idstring required

A unique Base58 value identifying this object.

userstring required

A unique Base58 value identifying this object.

submitted_atstring date-time required

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

generated_atstring date-time nullable required

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_enabledboolean

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.

filtersstring required

A unique Base58 value identifying this object.

ttlstring required

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

timezonestring

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