Get a widget

get

https://api.doit.com/analytics/v1/widgets/{widgetId}

Returns the latest precomputed cached result for one widget. This read does not refresh or
recompute the widget synchronously.

Use either the customer-specific id returned by the list-widgets operation or one of these
stable aliases:

current-month-cloud-spend — total cloud spend accumulated during the current calendar month.
current-month-cloud-forecast — forecast of total cloud spend for the current calendar month.

The two concrete alias requests are:

GET https://api.doit.com/analytics/v1/widgets/current-month-cloud-spend
GET https://api.doit.com/analytics/v1/widgets/current-month-cloud-forecast

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.

The result's period.endTime is exclusive. Monetary amount values are decimal strings and
currency values are ISO 4217 currency codes. monthToMonthGrowthPercentage and
monthToMonthGrowthAmount are both null when no comparable prior-period value exists.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

widgetId

string

required

length ≥ 1

Stable widget alias or customer-specific widget ID returned by listWidgets. Use
current-month-cloud-spend for current-month accumulated spend or
current-month-cloud-forecast for the current-month forecast.

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 widget and its latest precomputed result.

401Missing or invalid credentials.

403Authenticated but not authorized to perform this request.

404The widget identifier is unknown, no cached result is available yet, or the customer has no billing data. Inspect code to choose the recovery action.

500The cached result cannot be served or an unexpected internal error occurred. Inspect code; contact DoiT support with the Request-Id for non-retryable or persistent errors.

503The last background computation failed. This error is retryable; retry later.