Get metric group — LaunchDarkly

Get information for a single metric group from the specific project.

Expanding the metric group response

LaunchDarkly supports two fields for expanding the “Get metric group” response. By default, these fields are not included in the response.

To expand the response, append the expand query parameter and add a comma-separated list with either or both of the following fields:

experiments includes all experiments from the specific project that use the metric group
experimentCount includes the number of experiments from the specific project that use the metric group

For example, expand=experiments includes the experiments field in the response.

Path parameters

projectKeystringRequired

The project key

metricGroupKeystringRequired

The metric group key

Query parameters

expandstringOptional

A comma-separated list of properties that can reveal additional information in the response.

Response

Metric group response

_idstring

The ID of this metric group

keystring

A unique key to reference the metric group

namestring

A human-friendly name for the metric group

kindenum

Allowed values: funnelstandard

The type of the metric group

_linksmap from strings to objects

The location and content type of related resources

tagslist of strings

Tags for the metric group

_creationDatelong

Timestamp of when the metric group was created

_lastModifiedlong

Timestamp of when the metric group was last modified

maintainerobject

The maintainer of this metric

metricslist of objects

An ordered list of the metrics in this metric group

_versioninteger

The version of this metric group

descriptionstringOptional

Description of the metric group

_accessobjectOptional

Details on the allowed and denied actions for this metric group

experimentslist of objectsOptional

Experiments that use this metric group. Only included if specified in the expand query parameter in a getMetricGroup request.

experimentCountintegerOptional

The number of experiments using this metric group

Errors

1 curl https://app.launchdarkly.com/api/v2/projects/projectKey/metric-groups/metricGroupKey \ 2 -H "Authorization: <apiKey>"

1 { 2 "_id": "bc3e5be1-02d2-40c7-9926-26d0aacd7aab", 3 "key": "metric-group-key-123abc", 4 "name": "My metric group", 5 "kind": "funnel", 6 "_links": { 7 "parent": { 8 "href": "/api/v2/projects/my-project", 9 "type": "application/json" 10 }, 11 "self": { 12 "href": "/api/v2/projects/my-project/metric-groups/my-metric-group", 13 "type": "application/json" 14 } 15 }, 16 "tags": [ 17 "ops" 18 ], 19 "_creationDate": 1000000, 20 "_lastModified": 1000000, 21 "maintainer": { 22 "member": { 23 "_links": { 24 "self": { 25 "href": "/api/v2/members/569f183514f4432160000007", 26 "type": "application/json" 27 } 28 }, 29 "_id": "569f183514f4432160000007", 30 "role": "admin", 31 "email": "ariel@acme.com", 32 "firstName": "Ariel", 33 "lastName": "Flores" 34 }, 35 "team": { 36 "customRoleKeys": [ 37 "access-to-test-projects" 38 ], 39 "key": "team-key-123abc", 40 "name": "QA Team", 41 "_links": { 42 "key": {} 43 } 44 } 45 }, 46 "metrics": [ 47 { 48 "key": "metric-key-123abc", 49 "name": "Example metric", 50 "kind": "pageview", 51 "_links": { 52 "self": { 53 "href": "/api/v2/metrics/my-project/my-metric", 54 "type": "application/json" 55 } 56 }, 57 "_versionId": "version-id-123abc", 58 "isNumeric": true, 59 "unitAggregationType": "sum", 60 "nameInGroup": "Step 1", 61 "randomizationUnits": [ 62 "user" 63 ] 64 } 65 ], 66 "_version": 1, 67 "description": "Description of the metric group", 68 "_access": { 69 "denied": [ 70 { 71 "action": "action", 72 "reason": { 73 "effect": "allow" 74 } 75 } 76 ], 77 "allowed": [ 78 { 79 "action": "action", 80 "reason": { 81 "effect": "allow" 82 } 83 } 84 ] 85 }, 86 "experiments": [ 87 { 88 "key": "experiment-key-123abc", 89 "name": "Example experiment", 90 "environmentId": "1234a56b7c89d012345e678f", 91 "environmentKey": "production", 92 "creationDate": 1000000, 93 "_links": { 94 "parent": { 95 "href": "/api/v2/projects/my-project/environments/my-environment", 96 "type": "application/json" 97 }, 98 "self": { 99 "href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment", 100 "type": "application/json" 101 } 102 }, 103 "archivedDate": 1000000 104 } 105 ], 106 "experimentCount": 0 107 }

1	curl https://app.launchdarkly.com/api/v2/projects/projectKey/metric-groups/metricGroupKey \
2	-H "Authorization: <apiKey>"

1	{
2	"_id": "bc3e5be1-02d2-40c7-9926-26d0aacd7aab",
3	"key": "metric-group-key-123abc",
4	"name": "My metric group",
5	"kind": "funnel",
6	"_links": {
7	"parent": {
8	"href": "/api/v2/projects/my-project",
9	"type": "application/json"
10	},
11	"self": {
12	"href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
13	"type": "application/json"
14	}
15	},
16	"tags": [
17	"ops"
18	],
19	"_creationDate": 1000000,
20	"_lastModified": 1000000,
21	"maintainer": {
22	"member": {
23	"_links": {
24	"self": {
25	"href": "/api/v2/members/569f183514f4432160000007",
26	"type": "application/json"
27	}
28	},
29	"_id": "569f183514f4432160000007",
30	"role": "admin",
31	"email": "ariel@acme.com",
32	"firstName": "Ariel",
33	"lastName": "Flores"
34	},
35	"team": {
36	"customRoleKeys": [
37	"access-to-test-projects"
38	],
39	"key": "team-key-123abc",
40	"name": "QA Team",
41	"_links": {
42	"key": {}
43	}
44	}
45	},
46	"metrics": [
47	{
48	"key": "metric-key-123abc",
49	"name": "Example metric",
50	"kind": "pageview",
51	"_links": {
52	"self": {
53	"href": "/api/v2/metrics/my-project/my-metric",
54	"type": "application/json"
55	}
56	},
57	"_versionId": "version-id-123abc",
58	"isNumeric": true,
59	"unitAggregationType": "sum",
60	"nameInGroup": "Step 1",
61	"randomizationUnits": [
62	"user"
63	]
64	}
65	],
66	"_version": 1,
67	"description": "Description of the metric group",
68	"_access": {
69	"denied": [
70	{
71	"action": "action",
72	"reason": {
73	"effect": "allow"
74	}
75	}
76	],
77	"allowed": [
78	{
79	"action": "action",
80	"reason": {
81	"effect": "allow"
82	}
83	}
84	]
85	},
86	"experiments": [
87	{
88	"key": "experiment-key-123abc",
89	"name": "Example experiment",
90	"environmentId": "1234a56b7c89d012345e678f",
91	"environmentKey": "production",
92	"creationDate": 1000000,
93	"_links": {
94	"parent": {
95	"href": "/api/v2/projects/my-project/environments/my-environment",
96	"type": "application/json"
97	},
98	"self": {
99	"href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
100	"type": "application/json"
101	}
102	},
103	"archivedDate": 1000000
104	}
105	],
106	"experimentCount": 0
107	}