get
https://api.whippy.co/v1/metrics/events/fields
Lists the fields a metric event can filter, group and aggregate by, with what each supports.
Building an event from the response:
- Filter: a field with
filterable: truebecomes a filter
{"column": field, "comparison": one of comparisons, "value": ...}. Copyfield_type
(andfilter_typewhen set) onto the filter.in/not_intake a list. Whenvalues
is not empty, only those values are accepted; whenvalue_sourceis set, the field
holds IDs listed by that endpoint. - Group by: a field with
groupable: truebecomes{"field": field}ingroup_by. - Aggregate: a field with
aggregatable: truebecomes
{"aggregate_type": one of aggregate_types, "field": field, "field_type": field_type},
plus"analysis_field": truewhen the field hasanalysis_field: true.
metadata.event_aggregate_typesare the aggregates that take no field.
For non_custom reports, fields with required: true must be filtered exactly once, and
max_values caps the values of an in filter.
For custom_object_record.* events, pass custom_data_type_id to include that custom
object type's properties.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Callback
