GuideLab API
Reports

Get a report by ID

Returns one tenant-scoped report. Built-in slugs are expanded into their explicit adapter-backed configuration.

GET
/reports/{id}

Returns one tenant-scoped report. Built-in slugs are expanded into their explicit adapter-backed configuration.

Authorization

__Secure-guidelab-prod.session_token<token>

Production session cookie set for the guidelab.co domain by Better Auth

In: cookie

Path Parameters

id*string
Formatuuid

Response Body

application/json

curl -X GET "https://example.com/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "string",  "name": "string",  "description": "string",  "icon": "string",  "type": "built_in",  "templateSlug": "string",  "isPinned": true,  "sortOrder": 0,  "createdAt": "string",  "config": {    "definitionVersion": "v1",    "dataSource": "orders",    "columns": [      {        "fieldKey": "string",        "label": "string",        "aggregation": "sum",        "format": "string",        "width": 1      }    ],    "filters": [],    "groupBy": [],    "sortBy": [],    "dateRange": {      "fieldKey": "string",      "preset": "today",      "startDate": "string",      "endDate": "string"    },    "chart": {      "type": "bar",      "xAxisField": "string",      "yAxisFields": [        "string"      ],      "enabled": true    },    "pageSize": 1  },  "createdBy": "string",  "updatedAt": "string"}
Empty
Empty

Export a report as CSV POST

Executes one tenant-scoped report query and returns a synchronous CSV under fixed request, row, byte, time, and query-fan-out ceilings.

List available report data sources GET

Returns the serializable field, type, aggregation, sort, and filter allowlists for all four code-owned report adapters.