Create a Metric

post https://api.develrc-app.optimizely.com/v2/metrics

Create a new Metric

Body Params

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.

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 | null

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

metrics

array of objects

length between 0 and 2

metrics

Responses

Response body

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 | null

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

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.

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.develrc-app.optimizely.com/v2/metrics \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "event_scoped": false
8
}
9
'

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?

Create a Metric

201Metric successfully created response

400Metric validation error

409Same metric already exists