GuideLab Docs
Reports

Report templates and saved reports

GET
/reports/catalog

Authorization

__Secure-guidelab-prod.session_token<token>

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

In: cookie

Response Body

application/json

curl -X GET "https://example.com/reports/catalog"
{  "templates": [    {      "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",      "category": "string"    }  ],  "saved": [    {      "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",      "category": "string"    }  ],  "canManage": true}

Get a report by ID GET

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

List available report data sources GET

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