A valid request URL is required to generate request examples{
"dashboard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"kind": "metric",
"metric": "<string>",
"saved_query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"funnel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Create a dashboard
Requires analytics:read. A dashboard is an ordered list of at most 24 widgets, and a widget points at a question this API already answers: a metric column, a saved query or a funnel.
There is no dashboard data route. Each widget is drawn by calling the read it names — /analytics/metrics for a metric, /analytics/events/counts for a saved_query, /analytics/funnels/{id}/results for a funnel — so the rules those reads follow are written down exactly once. position is the order you send: the list is the layout.
Names are unique per organization; a duplicate answers 409 dashboard_exists. A widget naming a saved query or funnel from another organization answers 404, the same as reading that id directly.
A valid request URL is required to generate request examples{
"dashboard": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"kind": "metric",
"metric": "<string>",
"saved_query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"funnel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Body
Response
The dashboard, widgets included.
An ordered list of widgets, each pointing at a question this API already answers. A dashboard computes nothing and has no data route of its own.
Show child attributes
Show child attributes