Skip to main content
GET
Aggregate objects of a type

Authorizations

Authorization
string
header
required

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

type_name
string
required

The object type, for example deal, account, person, meeting or commitment. Call GET /types to see the types in your workspace.

Example:

"deal"

Query Parameters

group_by
string

A declared dimension to group by, for example stage on deal.

metric
string[]

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.

filters
string

A JSON object of field filters, URL-encoded. Example: {"stage":"Negotiation"}. The server ignores a value that is not a JSON object.

time_bucket
enum<string>

Group results by this time period. You must also set time_field.

Available options:
week,
month,
quarter
time_field
string

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.