Skip to main content

The org's grounded analysis data model (schema + enums + joins + custom-field refs)

GET 
/v1/analytics/data-model

Return your organization's analysis data model — the grounded schema the natural-language agent itself reasons over.

It covers tables with their columns and types, the real enum values a column accepts, custom-field SQL references such as (custom_fields->>'budget')::numeric, the join graph between tables, and your lifecycle and deal stages. Because it reflects live schema plus your own customisations, it tells you what to write rather than what the generic product docs describe.

Read it before writing SQL for run-query so you use real column, value and stage names. The manifest is cached for about an hour; pass force_refresh=true after a schema change.

Requires the analytics:read scope.

Request​

Responses​

Successful Response

Last updated on