Show an AI Config's targeting

GET

/api/v2/projects/:projectKey/ai-configs/:configKey/targeting

GET

/api/v2/projects/:projectKey/ai-configs/:configKey/targeting

1 import requests
2 
3 url = "https://app.launchdarkly.com/api/v2/projects/projectKey/ai-configs/configKey/targeting"
4 
5 headers = {
6     "LD-API-Version": "beta",
7     "Authorization": "<apiKey>"
8 }
9 
10 response = requests.get(url, headers=headers)
11 
12 print(response.json())

Try it

1 {
2   "createdAt": 0,
3   "environments": {
4     "key": {
5       "contextTargets": [
6         {
7           "contextKind": "contextKind",
8           "values": [
9             "values",
10             "values"
11           ],
12           "variation": 5
13         },
14         {
15           "contextKind": "contextKind",
16           "values": [
17             "values",
18             "values"
19           ],
20           "variation": 5
21         }
22       ],
23       "enabled": true,
24       "fallthrough": {
25         "variation": 5,
26         "rollout": {
27           "contextKind": "contextKind",
28           "variations": [
29             {
30               "variation": 9,
31               "weight": 3,
32               "_untracked": true
33             },
34             {
35               "variation": 9,
36               "weight": 3,
37               "_untracked": true
38             }
39           ],
40           "bucketBy": "bucketBy",
41           "experimentAllocation": {
42             "canReshuffle": true,
43             "defaultVariation": 2,
44             "type": "type"
45           },
46           "seed": 7
47         }
48       },
49       "lastModified": 2,
50       "rules": [
51         {
52           "clauses": [
53             {
54               "attribute": "attribute",
55               "id": "id",
56               "negate": true,
57               "op": "op",
58               "values": [
59                 "",
60                 ""
61               ]
62             },
63             {
64               "attribute": "attribute",
65               "id": "id",
66               "negate": true,
67               "op": "op",
68               "values": [
69                 "",
70                 ""
71               ]
72             }
73           ],
74           "trackEvents": true
75         },
76         {
77           "clauses": [
78             {
79               "attribute": "attribute",
80               "id": "id",
81               "negate": true,
82               "op": "op",
83               "values": [
84                 "",
85                 ""
86               ]
87             },
88             {
89               "attribute": "attribute",
90               "id": "id",
91               "negate": true,
92               "op": "op",
93               "values": [
94                 "",
95                 ""
96               ]
97             }
98           ],
99           "trackEvents": true
100         }
101       ],
102       "targets": [
103         {
104           "contextKind": "contextKind",
105           "values": [
106             "values",
107             "values"
108           ],
109           "variation": 5
110         },
111         {
112           "contextKind": "contextKind",
113           "values": [
114             "values",
115             "values"
116           ],
117           "variation": 5
118         }
119       ],
120       "trackEvents": true,
121       "trackEventsFallthrough": true,
122       "_environmentName": "_environmentName",
123       "_version": 7,
124       "offVariation": 4
125     }
126   },
127   "experiments": {
128     "baselineIdx": 1,
129     "items": [
130       {
131         "metricKey": "my-metric",
132         "_metric": {
133           "_id": "5902deadbeef667524a01290",
134           "_versionId": "version-id-123abc",
135           "key": "metric-key-123abc",
136           "name": "My metric",
137           "kind": "custom",
138           "_links": {
139             "parent": {
140               "href": "/api/v2/metrics/my-project",
141               "type": "application/json"
142             },
143             "self": {
144               "href": "/api/v2/metrics/my-project/my-metric",
145               "type": "application/json"
146             }
147           },
148           "tags": [
149             "tags"
150           ],
151           "_creationDate": 1,
152           "experimentCount": 0,
153           "metricGroupCount": 0,
154           "guardedRolloutCount": 0,
155           "_attachedFlagCount": 0,
156           "_site": {
157             "href": "href",
158             "type": "type"
159           },
160           "_access": {
161             "denied": [
162               {
163                 "action": "action",
164                 "reason": {
165                   "effect": "allow",
166                   "resources": [
167                     "proj/*:env/*;qa_*:/flag/*"
168                   ],
169                   "notResources": [
170                     "notResources",
171                     "notResources"
172                   ],
173                   "actions": [
174                     "*"
175                   ],
176                   "notActions": [
177                     "notActions",
178                     "notActions"
179                   ],
180                   "role_name": "role_name"
181                 }
182               },
183               {
184                 "action": "action",
185                 "reason": {
186                   "effect": "allow",
187                   "resources": [
188                     "proj/*:env/*;qa_*:/flag/*"
189                   ],
190                   "notResources": [
191                     "notResources",
192                     "notResources"
193                   ],
194                   "actions": [
195                     "*"
196                   ],
197                   "notActions": [
198                     "notActions",
199                     "notActions"
200                   ],
201                   "role_name": "role_name"
202                 }
203               }
204             ],
205             "allowed": [
206               {
207                 "action": "action",
208                 "reason": {
209                   "effect": "allow",
210                   "resources": [
211                     "proj/*:env/*;qa_*:/flag/*"
212                   ],
213                   "notResources": [
214                     "notResources",
215                     "notResources"
216                   ],
217                   "actions": [
218                     "*"
219                   ],
220                   "notActions": [
221                     "notActions",
222                     "notActions"
223                   ],
224                   "role_name": "role_name"
225                 }
226               },
227               {
228                 "action": "action",
229                 "reason": {
230                   "effect": "allow",
231                   "resources": [
232                     "proj/*:env/*;qa_*:/flag/*"
233                   ],
234                   "notResources": [
235                     "notResources",
236                     "notResources"
237                   ],
238                   "actions": [
239                     "*"
240                   ],
241                   "notActions": [
242                     "notActions",
243                     "notActions"
244                   ],
245                   "role_name": "role_name"
246                 }
247               }
248             ]
249           },
250           "lastModified": {
251             "date": "2021-08-05T19:46:31Z"
252           },
253           "maintainerId": "569fdeadbeef1644facecafe",
254           "_maintainer": {
255             "_links": {
256               "self": {
257                 "href": "/api/v2/members/569f183514f4432160000007",
258                 "type": "application/json"
259               }
260             },
261             "_id": "569f183514f4432160000007",
262             "role": "admin",
263             "email": "ariel@acme.com",
264             "firstName": "Ariel",
265             "lastName": "Flores"
266           },
267           "description": "description",
268           "category": "Error monitoring",
269           "isNumeric": true,
270           "successCriteria": "HigherThanBaseline",
271           "unit": "unit",
272           "eventKey": "Order placed",
273           "randomizationUnits": [
274             "user"
275           ],
276           "filters": {
277             "type": "contextAttribute",
278             "op": "op",
279             "values": [
280               "JP"
281             ],
282             "negate": false,
283             "attribute": "country",
284             "contextKind": "user"
285           },
286           "unitAggregationType": "average",
287           "analysisType": "mean",
288           "percentileValue": 95,
289           "eventDefault": {
290             "disabled": true,
291             "value": 0
292           }
293         },
294         "environments": [
295           "production",
296           "test",
297           "my-environment"
298         ],
299         "_environmentSettings": {
300           "key": {
301             "startDate": 1,
302             "stopDate": 6,
303             "enabledPeriods": [
304               {
305                 "startDate": 7,
306                 "stopDate": 1
307               },
308               {
309                 "startDate": 7,
310                 "stopDate": 1
311               }
312             ]
313           }
314         }
315       },
316       {
317         "metricKey": "my-metric",
318         "_metric": {
319           "_id": "5902deadbeef667524a01290",
320           "_versionId": "version-id-123abc",
321           "key": "metric-key-123abc",
322           "name": "My metric",
323           "kind": "custom",
324           "_links": {
325             "parent": {
326               "href": "/api/v2/metrics/my-project",
327               "type": "application/json"
328             },
329             "self": {
330               "href": "/api/v2/metrics/my-project/my-metric",
331               "type": "application/json"
332             }
333           },
334           "tags": [
335             "tags"
336           ],
337           "_creationDate": 1,
338           "experimentCount": 0,
339           "metricGroupCount": 0,
340           "guardedRolloutCount": 0,
341           "_attachedFlagCount": 0,
342           "_site": {
343             "href": "href",
344             "type": "type"
345           },
346           "_access": {
347             "denied": [
348               {
349                 "action": "action",
350                 "reason": {
351                   "effect": "allow",
352                   "resources": [
353                     "proj/*:env/*;qa_*:/flag/*"
354                   ],
355                   "notResources": [
356                     "notResources",
357                     "notResources"
358                   ],
359                   "actions": [
360                     "*"
361                   ],
362                   "notActions": [
363                     "notActions",
364                     "notActions"
365                   ],
366                   "role_name": "role_name"
367                 }
368               },
369               {
370                 "action": "action",
371                 "reason": {
372                   "effect": "allow",
373                   "resources": [
374                     "proj/*:env/*;qa_*:/flag/*"
375                   ],
376                   "notResources": [
377                     "notResources",
378                     "notResources"
379                   ],
380                   "actions": [
381                     "*"
382                   ],
383                   "notActions": [
384                     "notActions",
385                     "notActions"
386                   ],
387                   "role_name": "role_name"
388                 }
389               }
390             ],
391             "allowed": [
392               {
393                 "action": "action",
394                 "reason": {
395                   "effect": "allow",
396                   "resources": [
397                     "proj/*:env/*;qa_*:/flag/*"
398                   ],
399                   "notResources": [
400                     "notResources",
401                     "notResources"
402                   ],
403                   "actions": [
404                     "*"
405                   ],
406                   "notActions": [
407                     "notActions",
408                     "notActions"
409                   ],
410                   "role_name": "role_name"
411                 }
412               },
413               {
414                 "action": "action",
415                 "reason": {
416                   "effect": "allow",
417                   "resources": [
418                     "proj/*:env/*;qa_*:/flag/*"
419                   ],
420                   "notResources": [
421                     "notResources",
422                     "notResources"
423                   ],
424                   "actions": [
425                     "*"
426                   ],
427                   "notActions": [
428                     "notActions",
429                     "notActions"
430                   ],
431                   "role_name": "role_name"
432                 }
433               }
434             ]
435           },
436           "lastModified": {
437             "date": "2021-08-05T19:46:31Z"
438           },
439           "maintainerId": "569fdeadbeef1644facecafe",
440           "_maintainer": {
441             "_links": {
442               "self": {
443                 "href": "/api/v2/members/569f183514f4432160000007",
444                 "type": "application/json"
445               }
446             },
447             "_id": "569f183514f4432160000007",
448             "role": "admin",
449             "email": "ariel@acme.com",
450             "firstName": "Ariel",
451             "lastName": "Flores"
452           },
453           "description": "description",
454           "category": "Error monitoring",
455           "isNumeric": true,
456           "successCriteria": "HigherThanBaseline",
457           "unit": "unit",
458           "eventKey": "Order placed",
459           "randomizationUnits": [
460             "user"
461           ],
462           "filters": {
463             "type": "contextAttribute",
464             "op": "op",
465             "values": [
466               "JP"
467             ],
468             "negate": false,
469             "attribute": "country",
470             "contextKind": "user"
471           },
472           "unitAggregationType": "average",
473           "analysisType": "mean",
474           "percentileValue": 95,
475           "eventDefault": {
476             "disabled": true,
477             "value": 0
478           }
479         },
480         "environments": [
481           "production",
482           "test",
483           "my-environment"
484         ],
485         "_environmentSettings": {
486           "key": {
487             "startDate": 1,
488             "stopDate": 6,
489             "enabledPeriods": [
490               {
491                 "startDate": 7,
492                 "stopDate": 1
493               },
494               {
495                 "startDate": 7,
496                 "stopDate": 1
497               }
498             ]
499           }
500         }
501       }
502     ]
503   },
504   "key": "key",
505   "name": "name",
506   "tags": [
507     "tags",
508     "tags"
509   ],
510   "variations": [
511     {
512       "_id": "_id",
513       "description": "description",
514       "name": "name",
515       "value": true
516     },
517     {
518       "_id": "_id",
519       "description": "description",
520       "name": "name",
521       "value": true
522     }
523   ],
524   "_version": 4,
525   "defaults": {
526     "onVariation": 6,
527     "offVariation": 1
528   }
529 }

Retrieves a specific AI Config's targeting by its key

Path parameters

projectKeystringRequired

configKeystringRequired

Response

Successful response

createdAtlong

Unix timestamp in milliseconds

environmentsmap from strings to objects

experimentsobject

keystring

namestring

tagslist of strings

variationslist of objects

_versioninteger

defaultsobject or null

Show an AI Config's targeting

Path parameters

Headers

Response

Errors