List Saved Analytics Dashboards
GET https://api.suger.cloud/ai/org/{orgId}/analytics/dashboard
Lists the organization's dashboards, newest first, a page at a time, each with its document. GetAnalyticsDashboard returns a dashboard's charts.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
limit | query | integer | no | |
cursor | query | string | no |
Responses
200 — A page of dashboards
Content-Type: application/json
Response fields:
| Field | Type | Required | Description |
|---|---|---|---|
data | array<AnalyticsDashboard> | yes | |
nextCursor | string or null | yes | |
hasMore | boolean | yes |
AnalyticsDashboard fields:
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
title | string | yes | |
description | string | no | |
version | integer | yes | |
createdBy | string or null | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
builtin | string | no | The built-in dashboard Analytics setup added this one as, such as `suger-finance-view`; absent on every other. Only setup sets it: a create or an update naming it is refused, and an update keeps it. |
filters | array<AnalyticsDashboardReadFilter> | yes | |
blocks | array<AnalyticsDashboardReadBlock> | yes | |
interactions | object | no | `crossFilter`: a click on a mark filters the other charts. `detail`: a mark's rows can be shown, and its chart broken down by another field. Both on when absent. |
400 — INVALID_REQUEST: the cursor is not valid
Content-Type: application/json · Schema: AnalyticsError
AnalyticsError fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | object | yes |
401 — No valid token
Content-Type: application/json · Schema: AiErrorResponse
AiErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Error message |
403 — Not a member of the organization
Content-Type: application/json · Schema: AiErrorResponse
AiErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Error message |
422 — INVALID_REQUEST: the query string is not valid
Content-Type: application/json · Schema: AnalyticsError
AnalyticsError fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | object | yes |
500 — ANALYTICS_UNAVAILABLE: an unexpected failure
Content-Type: application/json · Schema: AnalyticsError
AnalyticsError fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | object | yes |
503 — ANALYTICS_UNAVAILABLE: analytics is not configured or not ready
Content-Type: application/json · Schema: AnalyticsError
AnalyticsError fields:
| Field | Type | Required | Description |
|---|---|---|---|
error | object | yes |
Example
Generated from this operation's schema. Values are placeholders —
substitute your own ids, and set SUGER_TOKEN to a bearer token
from the OAuth client-credentials exchange.
Request
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/analytics/dashboard' \
-H "Authorization: Bearer $SUGER_TOKEN" Response — 200
{
"data": [
{
"id": "01H0000000000000000000",
"title": "string",
"version": 1,
"createdBy": "string",
"createdAt": "2026-01-31T12:00:00Z",
"updatedAt": "2026-01-31T12:00:00Z",
"filters": [
{}
],
"blocks": [
{}
],
"description": "string",
"builtin": "string",
"interactions": {
"crossFilter": true,
"detail": true
}
}
],
"nextCursor": "string",
"hasMore": true
} Error — 400
{
"error": {
"code": "string",
"message": "string",
"diagnostics": [
{
"code": "INVALID_QUERY",
"path": [
"string"
],
"message": "string",
"fix": "string",
"suggestions": [
"string"
]
}
],
"parameter": "string"
}
} View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.