Fetch a Single Exclusion Group

1 min

GET

https://api.optimizely.com/flags/v1//projects/{project_id}/groups/{group_id}

Fetch a single exclusion group by its id.

This operation corresponds to the fetch_group_url in a Groups response.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier
group_idintegerrequired
Example
54321
Description
The group identifier

Responses

200

Successful retrieval, creation or update of a Group.

The response includes RESTful JSON (https://restfuljson.org/) styled links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

Group

Example

{
  "archive_url": "/projects/12345/groups/archived",
  "archived": false,
  "created_time": "2019-05-08T00:00:00.000Z",
  "description": "Promo group description",
  "environment_key": "production",
  "id": 1,
  "name": "Promo group",
  "project_id": 12345,
  "revision": 1,
  "role": "viewer",
  "rules": {
    "321": {
      "created_time": "2022-01-08T00:00:00.000Z",
      "flag_key": "recurring_revenue",
      "flag_name": "Recurring Revenue",
      "flag_status": "unarchived",
      "rule_key": "experiment_one",
      "rule_name": "Experiment One",
      "traffic_allocation": 2000,
      "updated_time": "2022-01-08T00:00:00.000Z"
    }
  },
  "unarchive_url": "/projects/12345/groups/unarchived",
  "update_url": "/projects/12345/groups",
  "updated_time": "2019-05-08T00:00:00.000Z",
  "url": "/projects/12345/groups/123",
  "urn": "groups.flag.optimizely.com::1"
}

archive_urlobject
- UrlValue
archivedboolean
created_timestring<date-time>required
Example
2019-05-08T00:00:00.000Z
Format
date-time
delete_urlobject
- UrlValue
descriptionstring
Example
promotion group
environment_keystringrequired
Example
production
Min Length
1
idintegerrequired
Example
1
namestringrequired
Example
PromoGroup
project_idinteger<int64>
Description
The ID of the Project this Group belongs to
Format
int64
revisioninteger
Description
Revision number for tracking changes
rolestring
Example
admin
Description
Granular permission role
rulesobject
- GroupRuleMap
unarchive_urlobject
- UrlValue
update_urlobject
- UrlValue
updated_timestring<date-time>required
Example
2019-05-08T00:00:00.000Z
Format
date-time
urlobject
Description
Link to self
- UrlValue
urnstringrequired
Example
groups.flag.optimizely.com::1
Description
The URN for the Group

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

404Not found. No content

curl

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/groups/{group_id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/flags/v1//projects/{project_id}/groups/{group_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/flags/v1//projects/{project_id}/groups/{group_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/flags/v1//projects/{project_id}/groups/{group_id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful retrieval, creation or update of a Group.
The response includes RESTful JSON (https://restfuljson.org/) styled links. If a
link is not present in the response, it indicates a user is not authorized to access
the related resource.
{
  "archive_url": {},
  "archived": false,
  "created_time": "2019-05-08T00:00:00.000Z",
  "delete_url": {},
  "description": "promotion group",
  "environment_key": "production",
  "id": 1,
  "name": "PromoGroup",
  "project_id": "",
  "revision": 0,
  "role": "admin",
  "rules": {},
  "unarchive_url": {},
  "update_url": {},
  "updated_time": "2019-05-08T00:00:00.000Z",
  "url": {},
  "urn": "groups.flag.optimizely.com::1"
}

400

// Malformed requests and invalid parameter names and types

401

// Invalid credentials

403

// Do not have permission to perform the operation

404

// Not found. No content