Query API reference
Exact public analytics query request, filter value shapes, response columns, rows, metadata, and errors.
https://query.reportplane.com/queryThe endpoint supports direct browser requests from any origin. CORS preflight
allows Authorization and Content-Type without enabling credentialed cookies.
A browser-visible Runtime API Key should be dedicated to query access and
restricted to the minimum required Analytics APIs and filters. Send it as
Authorization: ApiKey rp_ak_...; reserve the Bearer scheme for runtime JWTs.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
analytics | string | Yes | Analytics API key or supported internal reference |
query | object | Yes | Caller-controlled query values allowed by the definition |
query.parameters | object | No | Values for supported definition parameters |
query.filters | array | No | Allowed runtime filters |
query.limit | positive integer | No | Requested bound; effective rows use the lowest request, definition, binding, and 100,000-row server limit |
Filter object:
| Field | Type | Required |
|---|---|---|
field | string | Yes |
operator | string | Yes |
value | depends on operator | Except exists |
between uses { "from": value, "to": value }. in, not_in, contains_any, and contains_all use a non-empty array. exists does not require a value.
Success response
The standard data object contains:
| Field | Type | Description |
|---|---|---|
columns | array | Output names and warehouse-neutral types |
rows | array of objects | Normalized query results |
result_metadata | object | Renderer-neutral roles and chart suggestions |
Resolution and access
The runtime resolves analytics inside the authenticated client's project, verifies the client's allowlist against the requested reference and resolved ID/key, then validates and executes the saved definition.
Error statuses
400: invalid body, unknown analytics reference in the project, invalid filter, incompatible type, or execution/planning error;401: authentication failed;403: identity binding or allowed-analytics policy failed.
Generated contract
Generate resource-specific OpenAPI with allowed filters and response shape from the Analytics API detail page in the console. OpenAPI generation is not part of Management API v1.