StoreBay Developers
Platform

Retrieve a report

GET
/reports/{id}

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Path Parameters

id*string

Identifier (key) of the resource.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reports/string"
{  "data": {    "id": "string",    "object": "report",    "name": "string",    "description": "string",    "category": "occupancy",    "period": "day",    "currency": "str",    "generated_at": "2019-08-24T14:15:22Z",    "data": [      {}    ]  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "not_found",    "message": "Resource not found."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}