Skip to main content

Get schema for the aggregate endpoint of resource.

GET 
/:api_prefix/:service_name/admin/:resource_name/aggregate/schema

Premium — provided by the paid habarico-enterprise package; a free-only install does not expose this endpoint.

Returns the schema describing fields and filters available on the resource aggregate endpoint (/admin/{resource_name}/aggregate). Only fields whitelisted for aggregation (non-empty aggregations) or for group_by (non-empty group_by) are listed. Filters are the same as those supported by the resource list endpoint (ComplexFilterBackend).

Available only on resources that opt in via aggregate_enabled: true in the resource schema. Returns HTTP 404 otherwise.

Request​

Responses​

Premium — returned only by the paid habarico-enterprise package.

Aggregate endpoint schema response.