List Metrics

get http://api.exp-metrics.optimizely.com:8000/v2/metrics

Get a list of all the Metrics for an account, a project, a combination of account and project,or a list of layer_ids. Each parameter must be provided exclusively, with the exception of thespecial case where both account_id and project_id may be provided in the same request.

time	status	user agent
Retrieving recent requests…

Loading…

👍
Beta
The metrics module is in beta. Optimizely is not currently accepting additional customers into this beta program.

Query Params

account_id

int64

The unique identifier for the account which contains the metrics.

project_id

int64

The unique identifier for the project which contains the metrics.

rep

string

Defaults to full

Modifies the structure of data that is returned. Defaults to the full representation, which contains all of the data for a metric and associated entities.

page

int32

Defaults to 0

Pagination parameter indicating the result set page at which to return a page of data. Defaults to 0.

per_page

int32

Defaults to 25

Pagination parameter indicating the page size (number of records) to return. Defaults to 25.

order

string

Comma separated list of metric properties that may be used to define the order of records in the paginated result set. The keywords ASC (ascending) and DESC (descending) may be applied to specify the direction of the sort for the named property. e.g., order=description DESC, metric_id ASC. If no direction is specified, it defaults to ASC. Changing the sequence of the properties provided to the order parameter changes the ordering of the result set. The result set will be ordered by the first property and then, within any common values of the first property, ordered by the second property, and so on (i.e., a stable sort is applied).

string

Case insensitive search term applied to the description, display_title, and id fields.

archived

boolean

Selects metrics based on the value of the archived field. If true, returns only archived metrics. If false, returns only non-archived metrics. If absent, returns all metrics.

Response

Response body

object

page

object

Information about the page of data returned.

number

int32

The ordinal number of the page in the set of all pages.

size

int32

The total number of entities included in the page.

total_elements

int64

The total number of entities included in all pages.

total_pages

int32

The total number of pages needed to include all entities, based on the page size.

content

array of objects

The list of metrics contained in the page.

content

object

updated_at

date-time

The date and time the entity was last modified.

event_id

int64

The unique identifier for the event which this metric measures.

aggregator

string

required

A value specifying the method used to aggregate the numerator of the metric value.

field

string

Specifies the numeric attribute to be aggregated when using the "sum" aggregator.

scope

string

A value specifying the logic for how conversions are attributed to decisions when calculating the metric values.

string

The unique identifier for the metric.

account_id

int64

required

The unique identifier for the account which contains the metric.

project_id

int64

The unique identifier for the project which contains the metric. Used when the metric's visibility is "project."

display_title

string

length between 0 and 200

A human-friendly name for the metric.

description

string

length between 0 and 1000

A textual description of the metric.

event_type

string

A value specifying the action a visitor takes to trigger the event which the metric measures.

winning_direction

string

required

Specifies whether the customer considers a value higher or lower than the baseline as a positive outcome for the metric.

filter_combine_operator

string

A value specifying where all filter conditions or any single filter condition must be met for a conversion to be included in the metric calculation.

visibility

string

required

A value specifying the contexts in which the metric may be used. Account-visible metrics may be used by any experiment within any project in the account. Project-level metrics may be used by any experiment in the same project which contains the metric. Experiment-level metrics can only be used in the experiment they are associated with.

archived

boolean

When true, indicates the metric is no longer in use and is not available for new experiments.

alias

string

A hash value that serves as a method to determine whether two metrics are the same.

event_scoped

boolean

Defaults to false

When true, indicates that the metric should be evaluated based on the occurrence of the event.

usage_count

int64

The total number of experiments, campaigns, and feature rules that currently use the metric.

event_properties

array of objects

event_properties

object

updated_at

date-time

The date and time the entity was last modified.

metric_id

string

The unique identifier for the metric which contains the filter condition.

event_property_id

string

The unique identifier for the event property.

name

string

required

length between 0 and 100

A human-friendly name for the event property.

condition_operator

string

required

A value specifying what comparison will be used when determining whether a conversion matches the filter condition.

value

string

required

length between 0 and 1000

The value that the conversion's event property value will be compared against.

data_type

string

required

The particular kind of data which the event property contains.

metrics

array of objects

length between 0 and 2

metrics

object

updated_at

date-time

The date and time the entity was last modified.

event_id

int64

The unique identifier for the event which this metric measures.

aggregator

string

required

A value specifying the method used to aggregate the numerator of the metric value.

field

string

Specifies the numeric attribute to be aggregated when using the "sum" aggregator.

scope

string

A value specifying the logic for how conversions are attributed to decisions when calculating the metric values.

metric_id

string

The unique identifier for the metric.

submetric_id

string

The unique identifier for the submetric.

role

string

required

A value specifying the use of the submetric in the metric calculation.

👍Beta

200Successfully metric found response

👍
Beta