Get report

Retrieves a report by ID. Status transitions: PENDING → PROCESSING → SUCCEEDED | FAILED. Requires the REPORTS_READ scope.

Authorization

AuthorizationBearer <token>

Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.

In: header

Path Parameters

storeId*string

Length12 <= length <= 48

reportId*string

Length12 <= length <= 48

Header Parameters

idempotency-key?string

Length8 <= length <= 32

Response Body

`application/json`

curl -X GET "https://example.com/stores/stringstring/reports/stringstring"

{  "ok": true,  "data": {    "id": "rpt_8h4t6sqzy3x9w5n2k1m0vqbf",    "type": "PAYMENT_ACTIVITY",    "status": "SUCCEEDED",    "formats": [      "CSV",      "JSON"    ],    "periodStart": "2026-04-01T00:00:00.000Z",    "periodEnd": "2026-05-01T00:00:00.000Z",    "rowCount": 1247,    "sizeBytes": 412980,    "durationMs": 8412,    "errorMessage": null,    "requestedByAccountId": null,    "requestedByTokenId": "stk_4tzcbfp2v8q1mzwxj5h0r1n",    "startedAt": "2026-05-22T10:00:00.100Z",    "completedAt": "2026-05-22T10:00:08.512Z",    "createdAt": "2026-05-22T10:00:00.000Z",    "updatedAt": "2026-05-22T10:00:08.512Z"  }}

Get report

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`