Model: CampaignResponse

1 min

Model Parameters

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