Query reporting data
Queries reporting data from specified datasources with optional filters and groupBy clauses. Supports aggregation and date truncation for time-based grouping.
Authorizations
Your unique Avido API key
Your unique Avido Application ID
Body
Request body for querying reporting data
Datasource to query
task, test, eval, topic, tag, human_annotation "task"
IANA timezone identifier for date filter resolution (e.g., 'America/New_York', 'Europe/London', 'UTC')
"America/New_York"
Number of items to skip before starting to collect the result set.
0 <= x <= 90071992547409910
Number of items to include in the result set.
1 <= x <= 10025
Optional filters to apply to the query. Each filter must specify a type (string/number/boolean/date) that matches the column type.
Filter for string columns using eq/neq operators
- ReportingQueryStringFilter
- ReportingQueryNumberFilter
- ReportingQueryBooleanFilter
- ReportingQueryDateFilter
Optional group by clauses for aggregating results. For date columns, dateTrunc is required.
Group by specification for non-date columns
- ReportingQueryGroupByBase
- ReportingQueryGroupByDate
Optional measurements/aggregations to compute when using groupBy. Defaults to count if not specified. Use avg/sum/min/max for numeric or boolean columns.
Optional ordering specification. If not specified, defaults to ordering by all groupBy columns (with createdAt priority) then measurements. For non-groupBy queries, defaults to createdAt DESC, id DESC.
When true, includes archived entities (tasks, topics, tags) in the query results. Defaults to false, which filters out archived data.
false