List executed reports

List all executed reports that have been generated.

GET /report-executions

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListAllReportExecutionsRequest req = new ListAllReportExecutionsRequest() {};

ListAllReportExecutionsResponse? res = await sdk.ReportExecutions.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

200

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "context": {
        "reference_timestamp": "2023-11-07T05:31:56Z",
        "reference_timezone": "<string>"
      },
      "report": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "merchant_account_id": "<string>",
        "name": "<string>",
        "type": "report",
        "creator_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "creator_display_name": "Jane Doe",
        "creator_type": "user"
      },
      "type": "report-execution"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

This endpoint requires the reports.read scope.

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.

Example:

"default"

Query Parameters

cursor · string | null

A pointer to the page of results to return.

Example:

"ZXhhbXBsZTE"

limit · integer · default: 20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100

Example:

20

report_name · string | null

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

Example:

"My report"

created_at_lte · string<date-time> | 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.

Example:

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

created_at_gte · string<date-time> | 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.

Example:

"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.

Available options: dispatched, failed, pending, processing, succeeded

Example:

"succeeded"

creator_id · string<uuid>[] | null

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

Example:

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

Response

200

application/json

Successful Response

items · ReportExecution · object[] · required

A list of items returned for this request.

Show child attributes

limit · integer · default: 20

The number of items for this page.

Required range: 1 <= x <= 100

Example:

20

next_cursor · string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000

Example:

"ZXhhbXBsZTE"

previous_cursor · string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000

Example:

"Xkjss7asS"