Fetch a custom view's data, scoped to one customer (experimental) | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customViewsExperimental.getCustomViewData("monthly-sales-summary", {
        customerId: "cust_987654321",
    });
}
main();

{
  "data": {
    "query_01": [
      {
        "date": "2024-05-01",
        "total_sales": "15230",
        "transactions": 120
      },
      {
        "date": "2024-05-02",
        "total_sales": "17890",
        "transactions": 135
      }
    ],
    "query_02": [
      {
        "region": "North America",
        "revenue": "452300",
        "units_sold": 13400
      },
      {
        "region": "Europe",
        "revenue": "389000",
        "units_sold": 11250
      }
    ]
  }
}

⚠️ 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.

Runs every stored query of the view on the read-only analytics database, scoped to the caller’s organization AND the given customer (both enforced as ClickHouse row filters), and returns the result sets keyed by query id. The customer scope is enforced by the database — it cannot be widened by the stored SQL.

⚠️ **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. Runs every stored query of the view on the read-only analytics database, scoped to the caller's organization AND the given customer (both enforced as ClickHouse row filters), and returns the result sets keyed by query id. The customer scope is enforced by the database — it cannot be widened by the stored SQL.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

displayIdstringRequired

Query parameters

customerIdstringRequired>=1 character

Customer to scope the data to (dev/preview only; the embed derives this from the verified token).

Response

200

datamap from strings to lists of maps from strings to any

Result sets keyed by query id. Each value is an array of row objects (column name → value); 64-bit integers are returned as JSON strings to preserve precision.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

408

Request Timeout Error

429

Too Many Requests Error

500

Internal Server Error