Get executed report

Fetch a specific executed report.

GET /report-executions/{report_execution_id}

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;

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

var res = await sdk.Reports.Executions.GetAsync(reportExecutionId: "003bc416-f32a-420c-8eb2-062a386e1fb0");

// handle response

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "dispatched",
  "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"
}

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.

Example:

"default"

Path Parameters

report_execution_id · string<uuid> · required

The ID of the execution of a report to retrieve details for.

Example:

"003bc416-f32a-420c-8eb2-062a386e1fb0"

Response

200

application/json

Successful Response

id · string<uuid> · required

The unique ID for the report execution.

Example:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

created_at · string<date-time> · required

The date this report execution was created at.

Example:

"2024-05-30T12:34:56.000Z"

updated_at · string<date-time> · required

The date this report execution was last updated.

Example:

"2024-05-30T13:00:00.000Z"

status · enum<string> · required

The status of the report execution.

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

Example:

"succeeded"

context · ReportExecutionContext · object · required

The context for the report execution.

Show child attributes

report · ReportSummary · object · required

The report this execution belongs to.

Show child attributes

type · string · default: report-execution

Always report-execution.

Allowed value: "report-execution"

Example:

"report-execution"