Aggregate objects of a type
Counts objects, or computes declared measures, grouped by one dimension or by time. GET /types/{type_name} lists the measures and dimensions of a type. This endpoint does not take a privacy parameter. Rate limit: 120 requests per minute for each workspace.
Authorizations
A Doris API key that starts with sk-live-. A workspace admin creates keys in Settings > Workspace > Developer. A key works only on /api/v1/ontology/ routes.
Path Parameters
The object type, for example deal, account, person, meeting or commitment. Call GET /types to see the types in your workspace.
"deal"
Query Parameters
A declared dimension to group by, for example stage on deal.
A declared measure name, for example deal_count or pipeline_amount on deal. Repeat the parameter for more than one. Leave empty to use the count measure of the type.
A JSON object of field filters, URL-encoded. Example: {"stage":"Negotiation"}. The server ignores a value that is not a JSON object.
Group results by this time period. You must also set time_field.
week, month, quarter The declared date property to group by time, for example close_date.
Response
Groups or time buckets, with totals.
The response is of type object.