List Exclusion Groups

1 min

GET

https://api.optimizely.com/v2/groups

List Exclusion Groups under a Project

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.
Default
1
project_idinteger<int64>required
Description
The ID of the Project you would like to list all Exclusion Groups for
Format
int64

Responses

200Return all Exclusion Groups in the specified Project

Group[]
- archivedboolean
  Description
  Whether the group is archived
- createdstring<date-time>
  Description
  The time when the Exclusion Group was initially created
  Format
  date-time
- descriptionstring
  Description
  The description for an Exclusion Group
- entitiesGroupEntity[]
  Description
  Array of Group Entities in the Exclusion Group
  - idintegerrequired
    Example
    3000
    Description
    The unique identifier for the Group Entity
  - kindstring<Campaign | Experiment>required
    Description
    The kind of the Group Entity
    Allowed
    CampaignExperiment
  - weightintegerrequired
    Example
    1000
    Description
    The weight of the Group Entity. The weight is a value between 0 and 10000. An entity with weight 5000 will receive 50% of this group's traffic
- idinteger<int64>
  Example
  3000
  Description
  The unique identifier for the Exclusion Group
  Format
  int64
- last_modifiedstring<date-time>
  Description
  The last time the Exclusion Group was modified
  Format
  date-time
- namestringrequired
  Example
  Homepage Group
  Description
  Name of the Exclusion Group
- project_idinteger<int64>required
  Example
  1000
  Description
  The Project the Exclusion Group is in
  Format
  int64

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to access the Exclusion Groups in the specified Project

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Exclusion Groups not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/groups?per_page=25&page=1&project_id=integer%3Cint64%3E' \
     --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/v2/groups?per_page=25&page=1&project_id=integer<int64>", 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/v2/groups?per_page=25&page=1&project_id=integer<int64>")

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/v2/groups?per_page=25&page=1&project_id=integer<int64>"

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

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

print(response.text)

200

// Return all Exclusion Groups in the specified Project
[
  {
    "archived": false,
    "created": "",
    "description": "",
    "entities": [
      {
        "id": 3000,
        "kind": "",
        "weight": 1000
      }
    ],
    "id": 3000,
    "last_modified": "",
    "name": "Homepage Group",
    "project_id": 1000
  }
]

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to access the Exclusion Groups in the specified Project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Exclusion Groups not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}