DashboardsRetrieve dashboard

Retrieve dashboard

Fetch a single dashboard by ID. The dashboard must belong to the resolved location. Returns the full row (does not embed insights — use GET /dashboards/{id}/insights).

curl -X GET "https://mythic-analytics.gulp.workers.dev/builder/dashboards/123e4567-e89b-12d3-a456-426614174000?location_id=acme-retail" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "location_id": "acme-retail",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Marketing Overview",
    "description": "example_string",
    "is_public": false,
    "public_token": "4c3b2a1f6e5d4c3b2a1f6e5d4c3b2a1f",
    "canvas_id": "123e4567-e89b-12d3-a456-426614174000",
    "filters": {},
    "theme": {},
    "created_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z"
  }
}
GET
/dashboards/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need dashboards:read or dashboards:write. See Using an mcp_ key over HTTP.

Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need dashboards:read or dashboards:write. See Using an mcp_ key over HTTP.
path
idstring
Required

Dashboard UUID.

Format: uuid
query
location_idstring

Client location to scope the request to. Required when authenticating with an agency key (ak_). Ignored for viewer keys (sk_).

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need dashboards:read or dashboards:write. See Using an mcp_ key over HTTP.

Path Parameters

idstring
Required

Dashboard UUID.

Query Parameters

location_idstring

Client location to scope the request to. Required when authenticating with an agency key (ak_). Ignored for viewer keys (sk_).

Example:
acme-retail

Responses

dataobject