Skip to navigation
API Referencecustom-views-experimental

Get a custom view’s metadata + render bundle (experimental)

⚠️ Experimental — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.

Returns the view’s name, status, query ids, and the author render bundle for the owning organization. Only PUBLISHED views are returned; a DRAFT returns 404 (use getCustomViewAuthoring to read a DRAFT). Used by the trusted preview/embed frame to render the sandbox; the per-customer data is fetched separately via /:displayId/data.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

displayIdstringRequired

Response

200
displayIdstring
namestring
descriptionstring or null
statusenum
Allowed values:
queryIdslist of strings
Ids of the result sets the render bundle will receive.
renderBundlestring

Self-contained HTML document rendered inside the isolated sandbox iframe.

periodobject or null
The view's current default date range, or null if it uses no adjustable period.
filterslist of objects or null

The filter parameters this view accepts per request (pass values as filter_<name> query params on the data endpoint), or null if it declares none. Embedding hosts can render controls from the declared values.

scopeenum

‘customer’: data is scoped to one viewing customer and the view is embeddable per-customer. ‘organization’: data is org-wide and the view is internal-only.

Allowed values:
hierarchyEnabledbooleanOptional

Enable customer unit navigation for a customer-scoped view. Setting true requires customer hierarchies to be enabled for your organization, and every query must support unit selection. Existing views default to false.

capsEnabledbooleanOptional

Send the customer’s unit caps to the render bundle as context.caps. Needs hierarchyEnabled on a customer-scoped view. Turn it on only for views that draw cap usage: each load then reads cap usage from billing. Caps are spend policy, so an API key also needs read:billing to receive them in the data (they are left out otherwise) or to mint this view’s embed token. Defaults to false.

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error