Sign in
Reports

List report runs

List report runs

get/api/v1/report-runs

Query parameters

reportstring

Filter by report ID or Slug.

type'objectStorage' | 'stripe' | 'webhook'

The type of the report.

Filter by report type.

limitinteger

Number of report runs to return.

fromstring date-time
Example:2023-01-01T01:01:01.001Z

Start date-time in RFC 3339 format. Inclusive.

tostring date-time
Example:2023-01-01T01:01:01.001Z

End date-time in RFC 3339 format. Inclusive.

Response

The request has succeeded.

fromstring date-time required

The start of the period the report run covers.

idstring required

The ID of the report run.

reportIdstring required

The ID of the report.

timestring date-time required

The time the report run was created.

tostring date-time required

The end of the period the report run covers.

Example response

[
  {
    "from": "2023-01-01T01:01:01.001Z",
    "id": "01G65Z755AFWAKHE12NY0CQ9FH",
    "reportId": "01G65Z755AFWAKHE12NY0CQ9FH",
    "time": "2023-01-01T01:01:01.001Z",
    "to": "2023-01-01T01:01:01.001Z"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.