APPS_V2

Query Summary Endpoint

Changed on

Run a summary's part datasets and return the merged metric envelope.

Reuses DatasetQueryRequest — a summary takes the same date window and filters as a dataset query, applied identically to every part. timezone is threaded through exactly like apps.api.datasets.query_dataset_endpoint — see that endpoint's docstring.

post/api/v2/summaries/{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/summaries/{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
pageinteger
sizeinteger

Response

Successful Response

metricsobject required
last_event_timestring date-time nullable

Changes