Get a custom view's metadata + render bundle (experimental) | Paid

⚠️ 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 (DRAFT or PUBLISHED). Used by the trusted preview/embed frame to render the sandbox; the per-customer data is fetched separately via /:displayId/data.

⚠️ **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 (DRAFT or PUBLISHED). 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

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.

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.

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	import { PaidClient } from "@paid-ai/paid-node";
2
3	async function main() {
4	const client = new PaidClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.customViewsExperimental.getCustomView("displayId");
8	}
9	main();

1	{
2	"displayId": "view_9f8b7c6d",
3	"name": "Monthly Sales Overview",
4	"description": "A dashboard showing key sales metrics for the current month.",
5	"status": "DRAFT",
6	"queryIds": [
7	"query_123abc",
8	"query_456def"
9	],
10	"renderBundle": "<!DOCTYPE html><html><head><title>Render Bundle</title></head><body><h1>Sales Dashboard</h1></body></html>",
11	"period": {
12	"kind": "relative",
13	"unit": "month",
14	"amount": 1
15	},
16	"scope": "customer"
17	}