PRprobely
Reports

Partial Update to Report Request

Changed on
patch/report/{id}/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/report/{id}/
  • Auth
    API key in header Authorization

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'

failed_atstring date-time nullable

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

errorstring

Error message if report generation failed.

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'

failed_atstring date-time nullable required

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

errorstring required

Error message if report generation failed.

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').

Changes

  • 0b2f6cbe644dRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8b8322107b18Revision changes
    • breaking

      the request's body type changed from no type to object (media type: application/json)

    • breaking

      the request's body type changed from no type to object (media type: application/x-www-form-urlencoded)

    • breaking

      the request's body type changed from no type to object (media type: multipart/form-data)

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status