GET
/
report-executions
/
{report_execution_id}
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "mattilda",
    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
{
  "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"
  }
}
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_execution_id
string<uuid>
required

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

Examples:

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

Response

Successful Response

id
string<uuid>
required

The unique ID for the report execution.

Examples:

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

created_at
string<date-time>
required

The date this report execution was created at.

Examples:

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

updated_at
string<date-time>
required

The date this report execution was last updated.

Examples:

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

status
enum<string>
required

The status of the report execution.

Available options:
dispatched,
failed,
pending,
processing,
succeeded
context
object
required

The context for the report execution.

report
object
required

The report this execution belongs to.

type
string
default:report-execution

Always report-execution.

Allowed value: "report-execution"
Examples:

"report-execution"