List widgets

get

https://api.doit.com/analytics/v1/widgets

Returns the complete catalogue of preset widgets supported by the Analytics Widgets API.
Each entry contains a customer-specific id and a stable customer-facing alias; either
value can be passed to the get-widget operation. An id can vary by customer or service
tier, while an alias remains stable.

Authenticate with Authorization: Bearer <token>. Omit X-Tenant-Id when the credential
resolves to one customer. When the credential can act on multiple customers, send
X-Tenant-Id: <tenant-id> to select the customer. A 403 response means the caller or
selected customer is not authorized or entitled to use this API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Headers

X-Tenant-Id

string

Customer (tenant) ID for the request. This is separate from authentication: you still pass your personal or service account API token in the Authorization header (Bearer <token>). See Get Started.

When to omit (most callers): If your personal or service account token belongs to a single customer, omit this header. The API resolves that customer from the token.

When to send: If your credential can access more than one customer, set X-Tenant-Id to the customer ID you want to act on. A service account can select an active direct or nested descendant of its home customer; the endpoint's normal permissions, entitlements, and resource-ownership checks still apply. A service-account target outside that customer subtree returns 403 Forbidden. Prefer this header over the legacy customerContext query parameter, which only applies to legacy API keys and is ignored by personal and service account tokens.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK - The complete supported widget catalogue.

401Missing or invalid credentials.

403Authenticated but not authorized to perform this request.

500Unexpected server error.