custom-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.

get/experimental/views/{displayId}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/experimental/views/{displayId}
  • Auth: HTTP bearer

Path parameters

displayIdstring required

Response

200

hierarchyEnabledboolean

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.

capsEnabledboolean

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.

displayIdstring required
namestring required
descriptionstring nullable required
status'DRAFT' | 'PUBLISHED' required
queryIdsstring[] required

Ids of the result sets the render bundle will receive.

renderBundlestring required

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

scope'customer' | 'organization' required

'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.

Changes

No recorded changes to this operation across all 1 revision of this API.