GET
/
report-executions
curl --request GET \
  --url https://api.{id}.gr4vy.app/report-executions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "report-execution",
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "created_at": "2024-05-30T12:34:56.000Z",
      "updated_at": "2024-05-30T13:00:00.000Z",
      "status": "completed",
      "context": {
        "reference_timestamp": "2024-05-30T12:34:56.000Z",
        "reference_timezone": "UTC"
      },
      "report": {
        "type": "report",
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "merchant_account_id": "merchant-account-12345",
        "name": "Monthly Transaction Report",
        "creator_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "creator_display_name": "Jane Doe",
        "creator_type": "user"
      }
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Examples:

"default"

Query Parameters

​
cursor
string | null

A pointer to the page of results to return.

Examples:

"ZXhhbXBsZTE"

​
limit
integer
default:20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100
Examples:

20

​
report_name
string | null

Filters the reports by searching their name for (partial) matches.

Examples:

"My report"

​
created_at_lte
string | null

Filters the results to only reports 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.

Examples:

"2022-01-01T12:00:00+08:00"

​
created_at_gte
string | null

Filters the results to only reports 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.

Examples:

"2022-01-01T12:00:00+08:00"

​
status
enum<string>[] | null

Filters the results to only the reports that have a status that matches with any of the provided status values.

Examples:

"succeeded"

​
creator_id
string[] | null

Filters the results to only the reports that were created by the users with these IDs.

Examples:

"30362ed1-05cf-4a4c-8b4a-e76323df5f1e"

Response

200
application/json

Successful Response

The response is of type object.