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"
}
}Update a dashboard
Requires analytics:read. Partial on the name.
widgets is replaced whole when sent: the layout is the unit somebody saves, so an omitted widgets keeps the current one and [] clears it. Rearranging is sending the list in the new order — widget ids are not stable across a save, because a layout is not a set of addressable objects.
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"
}
}Autorizações
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.
Cabeçalhos
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.
Parâmetros de caminho
Corpo
Resposta
The dashboard as it now stands.
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