GET /campaigns

1 min

GET

https://api.cmp.optimizely.com/v3/campaigns

Experimental Get a list of campaigns.

Query Parameters

ownerstring
Example
127a32121da23c3a543
Description
Owner ID of the campaign
start_datestring
Example
2022-08-24T00:00:00.000Z
Description
Start date of the campaign, in ISO 8601 UTC format
end_datestring
Example
2022-08-24T00:00:00.000Z
Description
End date of the campaign, in ISO 8601 UTC format
offsetinteger
Example
5
Description
Starting index of results (zero indexed)
Default
0
Minimum
0
page_sizeinteger
Example
15
Description
Number of results to return per page
Default
10
Minimum
1
Maximum
100

Responses

200List of fetched campaigns

object
- dataCampaignListResponseItem[]required
  Description
  List of campaigns
  - idstringrequired
    Example
    8q7f910551b00a722e0418830cee6612
    Description
    Unique identifier of the campaign
  - titlestringrequired
    Example
    The awesome campaign
    Description
    Title of the campaign
  - descriptionstringrequired
    Example
    The awesome campaign's description
    Description
    Description of the campaign
  - start_datestringrequired
    Example
    2019-10-06
    Description
    Start date of the campaign in ISO 8601 format: YYYY-MM-DD
  - end_datestringrequired
    Example
    2019-10-16
    Description
    End date of the campaign in ISO 8601 format: YYYY-MM-DD
  - is_hiddenbooleanrequired
    Description
    Whether the campaign is hidden or not
  - reference_idstringrequired
    Example
    CPN-1589
    Description
    Reference identifier of the campaign
  - ownerobjectrequired
    Description
    Owner information of the campaign
    - idstring
      Example
      8q7f910551b00a722e0418830cee8211
      Description
      Unique identifier of the owner of the campaign
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612
      Description
      URL of the campaign
- paginationobjectrequired
  - Pagination
    - nextstringrequired
      Example
      https://api.cmp.optimizely.com/<some-path-to-next-page>?offset=10&page_size=10
      Description
      URL to the next page
    - previousstringrequired
      Description
      URL to the previous page
  - object
    - nextstring
      Example
      https://api.cmp.optimizely.com/v3/campaigns?offset=10&page_size=10

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url 'https://api.cmp.optimizely.com/v3/campaigns?offset=5&page_size=10' \
     --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.cmp.optimizely.com/v3/campaigns?offset=5&page_size=10", 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.cmp.optimizely.com/v3/campaigns?offset=5&page_size=10")

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.cmp.optimizely.com/v3/campaigns?offset=5&page_size=10"

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

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

print(response.text)

200

// List of fetched campaigns
{
  "data": [
    {
      "id": "8q7f910551b00a722e0418830cee6612",
      "title": "The awesome campaign",
      "description": "The awesome campaign's description",
      "start_date": "2019-10-06",
      "end_date": "2019-10-16",
      "is_hidden": false,
      "reference_id": "CPN-1589",
      "owner": {
        "id": "8q7f910551b00a722e0418830cee8211"
      },
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
      }
    }
  ],
  "pagination": {}
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}