Run an analytics SQL query
Changed onExecute a read-only SQL query against the analytics schema, scoped to your publication.
Auth: Requires an API key. Queries run as the publication that owns the API key; Row-Level Security guarantees that only that publication's rows are visible even if the SQL is unscoped.
SQL requirements:
- SELECT or WITH (CTE) statements only
- Reference tables unprefixed (e.g. FROM posts) — the analytics schema is the default search_path
- No semicolons, no writes, no DDL, no superuser functions
- Hard limit of 10,000 rows; anything over is truncated and truncated: true is returned
- 30-second statement timeout
Discovering the schema: call GET /v1/analytics/schema for column metadata.
Common queries: open rate, subscriber count, top posts by views, engagement over time, click-through rate.
For raw post-scoped tables, join through posts.draft_of to roll draft/version rows up to the canonical published post.
Request
- Base URLhttps://public.api.paragraph.com/api
- URLhttps://public.api.paragraph.com/api/v1/analytics/query
- AuthHTTP bearer
Request body
Response
Query executed successfully
Changes
- warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status
- warning
- info
endpoint added
- info