Read an Audience

1 min

GET

https://api.optimizely.com/v2/audiences/{audience_id}

Get metadata for a single Audience

Path Parameters

audience_idinteger<int64>required
Description
The Audience ID of the Audience you want to get
Format
int64

Responses

200Return Audience info

Audience
- archivedboolean
  Description
  Whether the Audience has been archived
  Default
  false
- conditionsstring
  Example
```
[
  "and",
  {
    "type": "language",
    "value": "es"
  },
  {
    "type": "location",
    "value": "US-CA-SANFRANCISCO"
  }
]
```
  Description
  A string defining the targeting rules for an Audience
- createdstring<date-time>
  Description
  The time the Audience was initially created
  Format
  date-time
- descriptionstring
  Example
  People that speak spanish and are in San Francisco
  Description
  A short description of the Audience
- experiment_countinteger<int64>
  Example
  123
  Description
  Number of experiments by audience_id
  Format
  int64
- for_journeyboolean
  Description
  Whether the Audience has been part of journey or not
  Default
  false
- idinteger<int64>
  Example
  5000
  Description
  The unique identifier for the Audience
  Format
  int64
- is_classicboolean
  Description
  Whether or not Audience is a classic Audience. If true, the Audience is only compatible with classic Experiments. Otherwise, the Audience may be used in Optimizely X Campaigns.
- last_modifiedstring<date-time>
  Description
  The last time the Audience was modified
  Format
  date-time
- namestring
  Example
  Spanish speaking San Franciscans
  Description
  The name of the Audience
- project_idinteger<int64>required
  Example
  1000
  Description
  The ID of the Project the Audience was created in
  Format
  int64
- segmentationboolean
  Description
  True if the Audience is available for segmentation on the results page (Audiences can only be used for segmentation in Optimizely Classic). Set to False if you intend to use this Audience only in Optimizely X. Note that a maximum of 10 Audiences can have segmentation set to True in any given Optimizely Classic project.
  Default
  false

400Invalid ID supplied

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

401Invalid credentials

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

403You do not have permission to access the specified Audience

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

404Audience 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/audiences/{audience_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/v2/audiences/{audience_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/v2/audiences/{audience_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/v2/audiences/{audience_id}"

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

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

print(response.text)

200

// Return Audience info
{
  "archived": false,
  "conditions": "[\"and\", {\"type\": \"language\", \"value\": \"es\"}, {\"type\": \"location\", \"value\": \"US-CA-SANFRANCISCO\"}]",
  "created": "",
  "description": "People that speak spanish and are in San Francisco",
  "experiment_count": 123,
  "for_journey": false,
  "id": 5000,
  "is_classic": false,
  "last_modified": "",
  "name": "Spanish speaking San Franciscans",
  "project_id": 1000,
  "segmentation": false
}

400

// Invalid ID supplied
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

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

403

// You do not have permission to access the specified Audience
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

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

default

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