GET /campaigns/{id}

1 min

GET

https://api.cmp.optimizely.com/v3/campaigns/{id}

Get a campaign

Path Parameters

idstringrequired
Example
8q7f910551b00a722e0418830cee6612
Description
Unique identifier of the campaign

Responses

200Fetched campaign

CampaignResponse
- 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
- created_atstring<date-time>required
  Example
  2035-10-06T13:15:30Z
  Description
  Creation date and time of the campaign, in ISO 8601 UTC format (2035-02-10T10:40:45Z)
  Format
  date-time
- is_hiddenbooleanrequired
  Description
  Whether the campaign is hidden or not
- statusstring<Not Started | Off Track | On Track | Complete | At Risk>required
  Example
  On Track
  Description
  Status of the campaign
  Allowed
  Not StartedOff TrackOn TrackCompleteAt Risk
- reference_idstringrequired
  Example
  CPN-1589
  Description
  Reference identifier of the campaign
- budgetobjectrequired
  - BudgetResponse
    - currency_codestringrequired
      Example
      USD
      Description
      Currency code of the budget
    - budgeted_amountstringrequired
      Example
      1000.50
      Description
      Planned amount for the campaign
- labelsResourceLabelResponse[]required
  Description
  Labels associated to the campaign
  - groupobjectrequired
    Description
    Label group
    - idstringrequired
      Example
      2467e583a60e23fda2b89db81a453cd2
      Description
      Identifier of the label group
    - namestringrequired
      Example
      Content Format
      Description
      Name of the label group
  - valuesobject[]required
    Description
    List of values of the label
    - idstringrequired
      Example
      71c378f3fee3d822759d1bdc2aab628c
      Description
      Identifier of the label value
    - namestringrequired
      Example
      Photos
      Description
      Name of the label value
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612
    Description
    URL of the campaign
  - briefstringrequired
    Example
    https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief
    Description
    URL of the campaign brief
  - ownerstringrequired
    Example
    https://api.cmp.optimizely.com/v3/users/6ea1bf781398c3147393arr1
    Description
    URL of the campaign owner
  - parent_campaignstringrequired
    Example
    https://api.cmp.optimizely.com/v3/campaigns/7u7f910551b00a722e0418830cee6643
    Description
    URL of the parent campaign
  - child_campaignsstring[]required
    Example
    [ "https://api.cmp.optimizely.com/v3/campaigns/6fb21acf987094513ecb4b58" ]
    Description
    URLs of the child campaigns

400Client error

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

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

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
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/{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.cmp.optimizely.com/v3/campaigns/{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.cmp.optimizely.com/v3/campaigns/{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.cmp.optimizely.com/v3/campaigns/{id}"

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

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

print(response.text)

200

// Fetched campaign
{
  "id": "8q7f910551b00a722e0418830cee6612",
  "title": "The awesome campaign",
  "description": "The awesome campaign's description",
  "start_date": "2019-10-06",
  "end_date": "2019-10-16",
  "created_at": "2035-10-06T13:15:30Z",
  "is_hidden": false,
  "status": "On Track",
  "reference_id": "CPN-1589",
  "budget": {},
  "labels": [
    {
      "group": {
        "id": "2467e583a60e23fda2b89db81a453cd2",
        "name": "Content Format"
      },
      "values": [
        {
          "id": "71c378f3fee3d822759d1bdc2aab628c",
          "name": "Photos"
        }
      ]
    }
  ],
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
    "brief": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief",
    "owner": "https://api.cmp.optimizely.com/v3/users/6ea1bf781398c3147393arr1",
    "parent_campaign": "https://api.cmp.optimizely.com/v3/campaigns/7u7f910551b00a722e0418830cee6643",
    "child_campaigns": [
      "https://api.cmp.optimizely.com/v3/campaigns/6fb21acf987094513ecb4b58"
    ]
  }
}

400

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

401

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

403

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

404

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