Automated Campaigns API Reference

Note

If you use the APIs provided here, you are subject to the API Terms of Use, and AdRoll Services Privacy Note

Description

AdRoll Automated Campaigns API 1.0 by AdRoll

Create and edit AdRoll strategies with the AdRoll Automated Campaigns API

Operations

GET /activate/api/v1/campaign

Fetch campaigns for a given strategy

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string Advertisable EID of requested strategy
strategy_eid True string Strategy EID of requested campaign
campaign_eid False string Campaign EID (if fetching a specific campaign)

Responses:

200 OK

A list of Campaign objects

Sample response:

{
  "data": [
    {
      "budget": 0.0, 
      "campaign_eid": "string", 
      "created_at": "string", 
      "product": "string", 
      "strategy_eid": "string", 
      "updated_at": "string"
    }
  ]
}

Response schema:

Schema-0
Type:object
data
Type:array of CampaignResponse
GET /activate/api/v1/strategy

Fetch strategy

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string Advertisable EID of requested strategy
strategy_eid False string Strategy EID of requested strategy

Responses:

200 OK

A list of Strategy objects

Sample response:

{
  "data": [
    {
      "advertisable_eid": "string", 
      "budget": 0.0, 
      "currency": "string", 
      "end_date": "string", 
      "start_date": "string", 
      "status": "string", 
      "strategy_eid": "string"
    }
  ]
}

Response schema:

Schema-1
Type:object
data
Type:array of StrategyResponse
POST /activate/api/v1/strategy

Create a new strategy or modify an existing strategy

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string Advertisable EID of requested strategy
strategy_eid False string Strategy EID (if editing an existing strategy)

Schema for request body: Strategy

{
  "budget": 0.0, 
  "budget_frequency": "string", 
  "conversion_segments": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "fb_ad_eids": [
    "string"
  ], 
  "kpi_goal": 0.0, 
  "kpi_metric": "string", 
  "monthly_budget_cap": 0.0, 
  "products": "string", 
  "start_date": "string", 
  "web_ad_eids": [
    "string"
  ]
}

Responses:

200 OK

A Strategy

Sample response:

{
  "data": [
    {
      "advertisable_eid": "string", 
      "budget": 0.0, 
      "currency": "string", 
      "end_date": "string", 
      "start_date": "string", 
      "status": "string", 
      "strategy_eid": "string"
    }
  ]
}

Response schema:

Schema-2
Type:object
data
Type:array of StrategyResponse

Definitions

StrategyResponse
Type:object
strategy_eid

EID of strategy

Type:string
advertisable_eid

EID of advertisable strategy is attached to

Type:string
end_date

End date of strategy in ISO-8601 format and UTC timezone

Type:string
Format:date-time
budget

Weekly budget of strategy in the currency specified by the currency field

Type:number
Format:float
currency

ISO-4217 currency code

Type:string
status

Status of strategy

Type:string
Enum:[u’paused’, u’live’]
start_date

Start date/time of strategy in ISO-8601 format and UTC timezone

Type:string
Format:date-time
Strategy
end_date

Date to stop running the strategy on in ISO-8601 format

Type:string
Format:date
fb_ad_eids

List of EIDs of existing Facebook ads

Type:array of items
kpi_goal

Value of KPI goal for specified KPI metric

Type:number
Format:float
budget

Budget for strategy in currency specified by currency parameter

Type:number
Format:float
currency

The currency of the strategy budget in ISO-4217 format

Type:string
budget_frequency

Period over which to spend the strategy budget.

Type:string
Enum:[u’daily’, u’weekly’]
conversion_segments

List of EIDs of existing conversion segments

Type:array of items
web_ad_eids

List of EIDs of existing web ads.

Type:array of items
products

Products to initialize campaigns with on this strategy

Type:string
Enum:[u’web’, u’web,fb’]
monthly_budget_cap

Maximum amount to spend during a month

Type:number
Format:float
start_date

Date to start running the strategy on.

Type:string
Format:date
kpi_metric

Metric used to measure KPI

Type:string
Enum:[u’CPA’, u’CPC’, u’CPM’]
CampaignResponse
strategy_eid

EID of strategy campaign is attached to

Type:string
product

Product of campaign

Type:string
created_at

Datetime of campaign creation in ISO-8601 format with UTC timezone

Type:string
Format:date-time
budget

Weekly budget of campaign in the currency specified by the currency field of the this campaign’s strategy.

Type:number
Format:float
updated_at

Datetime of last campaign update in ISO-8601 format with UTC timezone

Type:string
Format:date-time
campaign_eid

EID of campaign

Type:string