Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
scheduled_at,
-scheduled_at,
started_at,
-started_at
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • organisation: Filter by organisation ID, e.g. eq(organisation,<id>).
  • report: Filter by the report the run belongs to, e.g. eq(report,<id>). This is how a report's own run history is read.
  • status: Filter by outcome, e.g. eq(status,failed).
  • scheduled_at: Filter by the slot the run was for, e.g. ge(scheduled_at,2026-07-01T00:00:00Z).

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
report

Response

List of report runs.

JSON API response object

data
A list of report runs · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a report run is returned.

An organisation