GET
/
reports
/
{report_id}
/
executions
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"
);

ListReportExecutionsResponse? res = await sdk.Reports.Executions.ListAsync(
    reportId: "4d4c7123-b794-4fad-b1b9-5ab2606e6bbe",
    limit: 20
);

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

    res = await res.Next!();
}
{
  "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"
}

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 | null

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

Examples:

"default"

Path Parameters

​
report_id
string
required

The ID of the report to retrieve details for.

Examples:

"4d4c7123-b794-4fad-b1b9-5ab2606e6bbe"

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

Response

200
application/json

Successful Response

The response is of type object.