Sign in
APPS_V2

Query Chart Endpoint

Run a chart's underlying dataset query.

Returns the chart descriptor plus a chart-shaped envelope (columns/rows/meta). timezone is threaded through exactly like apps.api.datasets.query_dataset_endpoint — see that endpoint's docstring.

ONE execution path, per-endpoint PROJECTION: this endpoint never runs its own query — it calls the exact same run_dataset_query a plain dataset query uses, then reshapes that result's DatasetEnvelope into a ChartEnvelope (chart_columns instead of columns_descriptors, ChartMeta instead of DatasetMeta). A chart and its dataset can never disagree about RBAC, filters, or row data — only presentation differs.

post/api/v2/charts/{name}/query

Path parameters

namestring required

Headers

x-tenantstring required
x-user-group-idstring nullable
x-timezonestring nullable

Request body

filtersobject
start_datestring date required
end_datestring date required
granularity'day' | 'week' | 'month'
limitinteger
searchstring nullable

Response

Successful Response

rowsobject[] required

Changes

Changed in 2 of the 28 revisions of this API.32

  • 6aa0788aa5dc31See the full diff
    • ▲

      response property chart/reference/anyOf[subschema #1: ReferenceLineDescriptor]/of list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property chart/reference/anyOf[subschema #1: ReferenceLineDescriptor]/percentile list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property meta/reference/anyOf[subschema #1: ReferenceValue]/of list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      added the optional property chart/reference/anyOf[subschema #1: ReferenceLineDescriptor]/value to the response with the 200 status

      response-optional-property-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a71fce1f5c261See the full diff
    • ○

      endpoint added

      endpoint-added