Create metric — LaunchDarkly

Create a new metric in the specified project. The expected POST body differs depending on the specified kind property.

Path parameters

projectKeystringRequired

The project key

Request

This endpoint expects an object.

keystringRequired

A unique key to reference the metric

kindenumRequired

Allowed values: pageviewclickcustom

The kind of event your metric will track

namestringOptional

A human-friendly name for the metric

descriptionstringOptional

Description of the metric

selectorstringOptional

One or more CSS selectors. Required for click metrics only.

urlslist of objectsOptional

One or more target URLs. Required for click and pageview metrics only.

isActivebooleanOptional

Whether the metric is active. Set to true to record click or pageview metrics. Not applicable for custom metrics.

isNumericbooleanOptional

Whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false). Required for custom metrics only.

unitstringOptional

The unit of measure. Applicable for numeric custom metrics only.

eventKeystringOptional

The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only.

successCriteriaenumOptional

Allowed values: HigherThanBaselineLowerThanBaseline

Success criteria. Required for custom numeric metrics, optional for custom conversion metrics.

tagslist of stringsOptional

Tags for the metric

randomizationUnitslist of stringsOptional

An array of randomization units allowed for this metric

maintainerIdstringOptional

The ID of the member who maintains this metric

unitAggregationTypeenumOptional

Allowed values: averagesum

The method by which multiple unit event values are aggregated

analysisTypestringOptional

The method for analyzing metric events

percentileValueintegerOptional

The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile.

eventDefaultobjectOptional

Response

Metric response

_idstring

The ID of this metric

_versionIdstring

The version ID of the metric

keystring

A unique key to reference the metric

namestring

A human-friendly name for the metric

kindenum

Allowed values: pageviewclickcustom

The kind of event the metric tracks

_linksmap from strings to objects

The location and content type of related resources

tagslist of strings

Tags for the metric

_creationDatelong

Timestamp of when the metric was created

experimentCountintegerOptional

The number of experiments using this metric

metricGroupCountintegerOptional

The number of metric groups using this metric

_attachedFlagCountintegerOptional

The number of feature flags currently attached to this metric

_siteobjectOptional

Details on how to access the metric in the LaunchDarkly UI

_accessobjectOptional

Details on the allowed and denied actions for this metric

lastModifiedobjectOptional

maintainerIdstringOptional

The ID of the member who maintains this metric

_maintainerobjectOptional

Details on the member who maintains this metric

descriptionstringOptional

Description of the metric

categorystringOptional

The category of the metric

isNumericbooleanOptional

For custom metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false).

successCriteriaenumOptional

Allowed values: HigherThanBaselineLowerThanBaseline

For custom metrics, the success criteria

unitstringOptional

For numeric custom metrics, the unit of measure

eventKeystringOptional

For custom metrics, the event key to use in your code

randomizationUnitslist of stringsOptional

An array of randomization units allowed for this metric

unitAggregationTypeenumOptional

Allowed values: averagesum

The method by which multiple unit event values are aggregated

analysisTypeenumOptional

Allowed values: meanpercentile

The method for analyzing metric events

percentileValueintegerOptional

The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile.

eventDefaultobjectOptional

experimentslist of objectsOptional

Experiments that use this metric, including those using a metric group that contains this metric

metricGroupslist of objectsOptional

Metric groups that use this metric

isActivebooleanOptional

Whether the metric is active

_attachedFeatureslist of objectsOptional

Details on the flags attached to this metric

_versionintegerOptional

Version of the metric

selectorstringOptional

For click metrics, the CSS selectors

urlslist of maps from strings to anyOptional

For click and pageview metrics, the target URLs

1	curl -X POST https://app.launchdarkly.com/api/v2/metrics/projectKey \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"key": "metric-key-123abc",
6	"kind": "custom",
7	"isActive": true,
8	"isNumeric": false,
9	"eventKey": "trackedClick"
10	}'

1	{
2	"_id": "5902deadbeef667524a01290",
3	"_versionId": "version-id-123abc",
4	"key": "metric-key-123abc",
5	"name": "My metric",
6	"kind": "pageview",
7	"_links": {
8	"parent": {
9	"href": "/api/v2/metrics/my-project",
10	"type": "application/json"
11	},
12	"self": {
13	"href": "/api/v2/metrics/my-project/my-metric",
14	"type": "application/json"
15	}
16	},
17	"tags": [
18	"tags"
19	],
20	"_creationDate": 1000000,
21	"experimentCount": 0,
22	"metricGroupCount": 0,
23	"_attachedFlagCount": 0,
24	"_site": {
25	"href": "href",
26	"type": "type"
27	},
28	"_access": {
29	"denied": [
30	{
31	"action": "action",
32	"reason": {
33	"effect": "allow"
34	}
35	}
36	],
37	"allowed": [
38	{
39	"action": "action",
40	"reason": {
41	"effect": "allow"
42	}
43	}
44	]
45	},
46	"lastModified": {
47	"date": "2021-08-05T19:46:31Z"
48	},
49	"maintainerId": "569fdeadbeef1644facecafe",
50	"_maintainer": {
51	"_links": {
52	"self": {
53	"href": "/api/v2/members/569f183514f4432160000007",
54	"type": "application/json"
55	}
56	},
57	"_id": "569f183514f4432160000007",
58	"role": "admin",
59	"email": "ariel@acme.com",
60	"firstName": "Ariel",
61	"lastName": "Flores"
62	},
63	"description": "description",
64	"category": "Error monitoring",
65	"isNumeric": true,
66	"successCriteria": "HigherThanBaseline",
67	"unit": "unit",
68	"eventKey": "eventKey",
69	"randomizationUnits": [
70	"user"
71	],
72	"unitAggregationType": "average",
73	"analysisType": "mean",
74	"percentileValue": 95,
75	"eventDefault": {
76	"disabled": true,
77	"value": 1.1
78	},
79	"experiments": [
80	{
81	"key": "experiment-key-123abc",
82	"name": "Example experiment",
83	"environmentId": "1234a56b7c89d012345e678f",
84	"environmentKey": "production",
85	"creationDate": 1000000,
86	"_links": {
87	"parent": {
88	"href": "/api/v2/projects/my-project/environments/my-environment",
89	"type": "application/json"
90	},
91	"self": {
92	"href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
93	"type": "application/json"
94	}
95	},
96	"archivedDate": 1000000
97	}
98	],
99	"metricGroups": [
100	{
101	"key": "metric-group-key-123abc",
102	"name": "My metric group",
103	"kind": "funnel",
104	"_links": {
105	"parent": {
106	"href": "/api/v2/projects/my-project",
107	"type": "application/json"
108	},
109	"self": {
110	"href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
111	"type": "application/json"
112	}
113	}
114	}
115	],
116	"isActive": true,
117	"_attachedFeatures": [
118	{
119	"name": "Example flag",
120	"key": "flag-key-123abc",
121	"_links": {
122	"key": {}
123	}
124	}
125	],
126	"_version": 1,
127	"selector": "selector",
128	"urls": [
129	{
130	"key": "value"
131	}
132	]
133	}

Path parameters

Request

Response

Errors