Get all of the global metrics of an account

get https://api.optimizely.com/v2/metrics

Responses

Response body

array of objects

object

account_id

int64

account_id

aggregator

string

required

Defaults to unique

The aggregation function for the numerator of the metric. 'unique' measures the number of unique visitors/sessions that include the specified Event. 'count' measures the total number of occurrences of Event for the scope (visitor/session). 'sum' is the sum of the 'field' value

unique count sum bounce exit ratio

archived

boolean

Defaults to false

Whether the metric is archived

description

string

description

display_title

string

display title

display_unit

string

display unit

event_id

int64 | null

The ID for the Event to select data from. Omitted for global metrics that are not relative to a specific Event, i.e. "overall revenue"

event_properties

object

The conditions used to filter the metric on specific event property values.

event_type

string | null

The type of this Event

custom click pageview

field

string | null

The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted

revenue value session_duration

metrics

array of objects

A list of all metrics that will be used in the calculation of a ratio metric.

metrics

object

aggregator

string

Defaults to unique

unique count sum

event_id

int64 | null

The ID for the Event to select data from.

event_type

string

The type of this Event.

custom click pageview

field

string | null

The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted.

revenue value

scope

string

Defaults to visitor

Specifies how Events should be grouped. Can also be thought of as the denominator of the metric. 'session' divides by the number of sessions. "Influenced sessions", or sessions that do not contain a decision Event but carry a decision from a previous session are not included in counts for numerator or denominator. 'visitor' divides by the number of visitors. 'event' divides by the total occurrences (impressions) of the specified Event.

session visitor event

name

string

required

name

project_id

int64

required

project_id

scope

string

required

Defaults to visitor

session visitor event

time_window

string

The maximum amount of time a numerator event can differ from a denominator event in order to be included in a ratio metric. This can be an integer, or an integer followed by a letter denoting the unit of time (d = days, h = hours, m = minutes). If no unit of time is supplied, hours is assumed. If no value is supplied, a time window of 48 hours is assumed.

winning_direction

string

required

Defaults to increasing

The winning direction of this metric

increasing decreasing

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.optimizely.com/v2/metrics?per_page=25&page=1' \
3
     --header 'accept: application/json'

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

application/json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Get all of the global metrics of an account

200Returns all of the global metrics of an account.

401Invalid credentials

defaultUnexpected error