APPS_V2

Query Chart Endpoint

Changed on

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

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/api/v2/charts/{name}/query
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

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

  • 1b2d675195d7Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • b4beb9e80982Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status