Query metrics (GET)

get

https://api.lytics.io/v2/metric

Query one or more metrics via query parameters. The Metric API provides access to time series data for segments, streams, experiences, and other Lytics resources.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

account_id

string

The account ID. Defaults to the user's default account.

name

string

Friendly name to identify this metric request

dimension

string

enum

required

The dimension to query

dimension_id

string

required

The ID of the specific resource within the dimension (e.g. segment ID)

dimension_type

string

required

The metric type to retrieve (e.g. size, converted, conversionrate)

aggregation

string

enum

required

Comma-separated aggregation methods to apply

Allowed:

start_date

string

Start of the query range. Supports friendly times (e.g. now-7d). Required if end_date is set; cannot be used with range.

end_date

string

End of the query range. Supports friendly times (e.g. now). Required if start_date is set.

range

string

Time range from now (e.g. 7d for last 7 days). Cannot be used with start_date or end_date.

interval

string

Bucket size for time series grouping (e.g. 1d, 2h). Defaults to 2h.

smooth

boolean

Apply smoothing to the resulting metrics

round_dates

boolean

Round start and end dates down to the nearest day

include_empty_rows

boolean

Include zero-value buckets in the response

include_sum_of_buckets

boolean

Include a sum of all bucket values in the response

refresh_cache

boolean

Bypass the cache and read fresh from the time-series store

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Metrics Response

400Bad Request

500Internal Server Error