API Reference
  1. Klipfolio Public API
  2. /metrics/{metricId}/query

Query a metric's data over a time range

post
https://api-public.klipfolio.com/v1.0-beta/metrics//query

Recognised body fields: periodicity, groupby, aggregation, range, tz, filter, members_only - any other field is silently ignored rather than rejected, unlike the CRUD write endpoints. Requires the api:write scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string

e.g. '1M', '1d', '1w'.

groupby
array of strings
groupby
string
range
array of date-times
length between 2 and 2

A [start, end] ISO 8601 date-time pair.

range
string
filter
object

Keyed by dimension name. Each value is either a member filter - { type: 'member', members: [...], inverted } - keeping only the listed members, or all but them when inverted is true; or a conditional filter - { type: 'multi', filters: [{ type: 'text_condition', op, value, inverted }] } - where op is contains, starts_with or ends_with. Dimension names are the metric's own dimensions[].name.

boolean
Responses

Updated 28 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago

Did this page help you?