GET
/
report-executions
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/report-executions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "report-execution",
      "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "updated_at": "2013-07-16T19:23:00.000+00:00",
      "status": "succeeded",
      "context": {
        "reference_timestamp": "2013-07-16T19:23:00.000+00:00",
        "reference_timezone": "Europe/London"
      },
      "report": {
        "type": "report",
        "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "merchant_account_id": "default",
        "name": "Failed Authorizations 042022",
        "creator_id": "bd5d40d1-913b-419c-bd62-84efc46e0026",
        "creator_display_name": "John Doe",
        "creator_type": "user"
      }
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "<string>"
}

This endpoint requires the reports.read scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

limit
integer
default: 20

Defines the maximum number of items to return for this request.

created_at_gte
string

Filters the results to report executions created after this ISO date-time string. The time zone must be included.

Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00.

created_at_lte
string

Filters the results to report executions created before this ISO date-time string. The time zone must be included.

Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00.

report_name
string

Filters for executions of reports that have a matching name value. This filter is case-insensitive.

Ensure that when necessary, the value you pass for this filter is URL encoded.

status
enum<string>[]

Filters for report executions that have a matching status value.

This filter accepts multiple values.

Available options:
dispatched,
failed,
pending,
processing,
succeeded
creator_id
string[]

Filters the results to only match the reports that their creator_id matches with any of the provided creator IDs.

Response

200 - application/json
items
object[]

A list of report executions.

limit
integer
default: 20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Was this page helpful?

Update reportList executions for report