List queryable analytics views, columns, and types (experimental)

GET

https://api.agentpaid.io/api/v2/experimental/analytics/schema

GET

/api/v2/experimental/analytics/schema

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.analyticsExperimental.getAnalyticsSchema();
8 }
9 main();

1 {
2   "views": [
3     {
4       "name": "dim_users",
5       "comment": "Dimension table describing user entities",
6       "columns": [
7         {
8           "name": "user_id",
9           "type": "UUID",
10           "comment": "Unique identifier for the user"
11         },
12         {
13           "name": "email",
14           "type": "String",
15           "comment": "User's email address"
16         },
17         {
18           "name": "created_at",
19           "type": "DateTime",
20           "comment": "Timestamp when the user account was created"
21         },
22         {
23           "name": "is_active",
24           "type": "UInt8",
25           "comment": "Flag indicating if the user is active (1) or inactive (0)"
26         }
27       ]
28     },
29     {
30       "name": "fact_transactions",
31       "comment": "Fact table recording transaction events joined to dim_users via user_id",
32       "columns": [
33         {
34           "name": "transaction_id",
35           "type": "UUID",
36           "comment": "Unique identifier for the transaction"
37         },
38         {
39           "name": "user_id",
40           "type": "UUID",
41           "comment": "Foreign key referencing dim_users.user_id"
42         },
43         {
44           "name": "amount",
45           "type": "Decimal(10,2)",
46           "comment": "Transaction amount in USD"
47         },
48         {
49           "name": "transaction_date",
50           "type": "DateTime",
51           "comment": "Date and time when the transaction occurred"
52         },
53         {
54           "name": "payment_method",
55           "type": "String",
56           "comment": "Method used for payment (e.g., credit_card, paypal)"
57         }
58       ]
59     }
60   ]
61 }

⚠️ 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 analytics views available to POST /query, with column names, ClickHouse types, and descriptions. Dimensions (dim_*) describe entities; facts (fact_*) are event/transaction tables that join to dimensions via the *_id columns described in each comment.

⚠️ **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 analytics views available to POST /query, with column names, ClickHouse types, and descriptions. Dimensions (`dim_*`) describe entities; facts (`fact_*`) are event/transaction tables that join to dimensions via the `*_id` columns described in each comment.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Response

200

viewslist of objects

Errors

500

Internal Server Error