POST /audiences
Create an Audience for a Project
Servers
- https://api.optimizely.com/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | No |
The unique identifier for the Audience |
project_id |
Integer | Yes |
The ID of the Project the Audience was created in |
created |
String | No |
The time the Audience was initially created |
name |
String | No |
The name of the Audience |
archived |
Boolean | No |
Whether the Audience has been archived Default value: false |
description |
String | No |
A short description of the Audience |
experiment_count |
Integer | No |
Number of experiments by audience_id |
last_modified |
String | No |
The last time the Audience was modified |
conditions |
String | No |
A string defining the targeting rules for an Audience |
is_classic |
Boolean | No |
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. |
segmentation |
Boolean | No |
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 value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.