Widget Data
GET/api/v2/dashboard/widget/:key/data
Data for one provider-backed dashboard widget.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Query parameters (all optional, per widget): period (week|month), days (1–365), trailing_days (1–730), limit/per_page (1–50), metric, warehouse_id.
Responses
- 200
{data: …}— the widget's payload;datais null for a financial widget when the tenant hides financial data. - 403 — the widget shows money amounts and the user lacks the Financials → List permission (
financials.index); the message says so and what to do. A plain 403 means the user lacks the permission for the widget's own data. - 404 — unknown widget key, or a widget without a data provider.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.