Change a custom view's date range (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.

Updates the view’s default date range (the period applied to queries that use the {period_start:DateTime} / {period_end:DateTime} placeholders). Accepts a relative rolling window (e.g. last 30 days) or a fixed start/end range. Lets the period be changed after deployment without re-authoring the SQL. Applies to DRAFT or PUBLISHED views.

⚠️ **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. Updates the view's default date range (the period applied to queries that use the `{period_start:DateTime}` / `{period_end:DateTime}` placeholders). Accepts a relative rolling window (e.g. last 30 days) or a fixed start/end range. Lets the period be changed after deployment without re-authoring the SQL. Applies to DRAFT or PUBLISHED views.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

displayIdstringRequired

Request

Body

periodobjectRequired

Default date range for the view’s queries. Use {period_start:DateTime} / {period_end:DateTime} placeholders in your SQL to make the range adjustable. Either relative (unit+amount) or absolute (start+end).

Response

200

displayIdstring

Stable public identifier used in preview/embed URLs.

namestring

statusenum

A view is DRAFT until explicitly published; only PUBLISHED views are served to end-customers.

previewUrlstring or nullformat: "uri"

Absolute URL to open this view in the Paid app for preview. Surface it to the user after creating or publishing a view. Null when the app URL is not configured.

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

400

Bad Request Error

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.updateCustomViewPeriod("displayId", {
8	period: {
9	kind: "relative",
10	},
11	});
12	}
13	main();

1	{
2	"displayId": "view_3kf9a2",
3	"name": "string",
4	"status": "DRAFT",
5	"previewUrl": "https://app.paid.ai/custom-views/view_3kf9a2/preview",
6	"scope": "customer"
7	}