Skip to content
Docs
Open Backstage
Operation

Update a dashboard

PATCH/reports/dashboards/{id}

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional
Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.

Body

namestring
descriptionstring
accountIdstring
▼layoutobject[]
tileId*string
titlestring
reportIdstring
▶queryobject
▶vizobject
x*integer
y*integer
w*integer
h*integer
▼globalFiltersobject[]
key*string
label*string
control*"dateRange" | "select" | "multiselect"
memberstring
membersobject
defaultany

Returns

Dashboard updated

Errors

400
Bad Request - Invalid input
401
Unauthorized - Authentication required
403
Forbidden - Insufficient permissions
404
Not Found - Resource not found
500
Internal Server Error

Every error names its code and links to it. All error codes

curl -X PATCH "https://api.ticketlayer.com/v1/reports/dashboards/{id}" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string",    "accountId": "string",    "layout": [      {        "tileId": "string",        "title": "string",        "reportId": "string",        "query": {          "measures": [            "string"          ],          "dimensions": [            "string"          ],          "timeDimensions": [            {              "dimension": "string",              "granularity": "hour",              "dateRange": {}            }          ],          "filters": [            {              "member": "string",              "operator": "string",              "values": []            }          ],          "segments": [            "string"          ],          "order": {},          "limit": 0,          "offset": 0,          "timezone": "string"        },        "viz": {          "type": "table",          "x": "string",          "y": "string",          "series": "string"        },        "x": 0,        "y": 0,        "w": 0,        "h": 0      }    ],    "globalFilters": [      {        "key": "string",        "label": "string",        "control": "dateRange",        "member": "string",        "members": {}      }    ]  }'
Response 200
{
  "status": "success",
  "data": {
    "dashboard": {
      "id": "dsh_abc12345",
      "organisationId": "string",
      "accountId": "string",
      "name": "Sales overview",
      "description": "string",
      "layout": [
        {}
      ],
      "globalFilters": [
        {}
      ],
      "isSystem": true,
      "createdBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Try it in test mode

Path parameters
Body