Prospecting API Reference

Note

If you use the API provided here, you are subject to the API Terms of Use. To be able to create prospecting objects your advertisable(s) must be opted-in to the AdRoll Prospecting Agreement.

Note

We’ve introduced API keys, please read Migrating to API Keys

Description

Prospecting API v2 by AdRoll

Operations by Tag

Operations

GET /prospecting/api/v2/adgroups/(adgroup)

Get AdGroup by its EID.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID to get.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "ads": [
      {
        "ad_eid": "string", 
        "adgroup_eid": "string", 
        "admin_status": "string", 
        "advertisable_eid": "string", 
        "campaign_eid": "string", 
        "campaign_name": "string", 
        "eid": "string", 
        "is_active": true, 
        "skip_approve_ad": true, 
        "status": "string"
      }
    ], 
    "advertisable_eid": "string", 
    "audience": {
      "adgroup_eid": "string", 
      "created_at": "string", 
      "eid": "string", 
      "size": 0, 
      "source_segment_eid": "string", 
      "target_segment_eid": "string", 
      "updated_at": "string"
    }, 
    "auto_audience": true, 
    "auto_geo_targets": true, 
    "campaign_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "is_active": true, 
    "name": "string", 
    "status": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/adgroups/(adgroup)

Edit an AdGroup by its EID.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID to edit.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "ads": [
    {
      "ad_eid": "string", 
      "admin_status": "string", 
      "event_source": "fortyniner-ui", 
      "is_active": true, 
      "skip_approve_ad": true, 
      "user_status": "string"
    }
  ], 
  "auto_audience": true, 
  "auto_geo_targets": true, 
  "event_source": "fortyniner-ui", 
  "is_active": true, 
  "name": "string", 
  "user_status": "string"
}
Schema
Type:object
user_status
Type:string
Enum:active, paused
event_source
Type:string
Default:fortyniner-ui
ads
Type:array of items
is_active
Type:boolean
name
Type:string
auto_geo_targets
Type:boolean
auto_audience
Type:boolean

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "ads": [
      {
        "ad_eid": "string", 
        "adgroup_eid": "string", 
        "admin_status": "string", 
        "advertisable_eid": "string", 
        "campaign_eid": "string", 
        "campaign_name": "string", 
        "eid": "string", 
        "is_active": true, 
        "skip_approve_ad": true, 
        "status": "string"
      }
    ], 
    "advertisable_eid": "string", 
    "audience": {
      "adgroup_eid": "string", 
      "created_at": "string", 
      "eid": "string", 
      "size": 0, 
      "source_segment_eid": "string", 
      "target_segment_eid": "string", 
      "updated_at": "string"
    }, 
    "auto_audience": true, 
    "auto_geo_targets": true, 
    "campaign_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "is_active": true, 
    "name": "string", 
    "status": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/adgroups/(adgroup)/audience

Retrieve the audience for the specified AdGroup.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID to get audience from.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroup_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "size": 0, 
    "source_segment_eid": "string", 
    "target_segment_eid": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/adgroups/(adgroup)/audience

Create an audience for the specified AdGroup.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID to create an audience for.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "event_source": "fortyniner-ui", 
  "size": 0, 
  "source_segment_eid": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
source_segment_eid
Type:string
size
Required:True
Type:integer
Format:int32

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroup_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "size": 0, 
    "source_segment_eid": "string", 
    "target_segment_eid": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/adgroups/(adgroup)/flights

Get all Flights associated with an AdGroup.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID to get Flights from.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": [
    {
      "adgroup_eid": "string", 
      "created_at": "string", 
      "eid": "string", 
      "end_date": "string", 
      "start_date": "string", 
      "updated_at": "string"
    }
  ]
}
Schema
Type:object
results
Type:array of items
POST /prospecting/api/v2/adgroups/(adgroup)/flights

Create a new Flight for an AdGroup.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID that the new Flight is being added to
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
start_date

Flight start date.

Required:True
Type:string
end_date

Flight end date.

Type:string

Responses:

200 OK

Flight created successfully.

Schema as JSON:

{
  "results": {
    "adgroup_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "end_date": "string", 
    "start_date": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
400 Bad Request

The Flight was not created.

  • Your Flight might be missing start/end dates.
  • The start date might be greater than the end date.
  • Your Flight might be overlapping with another of the adgroup’s Flights.

Schema as JSON:

{
  "code": 0, 
  "message": "string"
}
Schema
Type:object
message

String, list, or dictionary of error messages. If a dictionary, the keys will be field names and the values will be lists of messages.

Type:string
code

HTTP error code.

Type:integer
Format:int32
GET /prospecting/api/v2/adgroups/(adgroup)/geo-targets

Retrieve GeoTargets for the specified AdGroup.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID to get GeoTargets from.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "data": [
      {
        "city": {
          "country_code": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string", 
          "name_localized": "string", 
          "region_code": "string"
        }, 
        "country": {
          "code": "string", 
          "country": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string", 
          "server_id": 0
        }, 
        "geo_eid": "string", 
        "geo_type": "string", 
        "metro": {
          "boundaries": "string", 
          "country": "string", 
          "country_code": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string", 
          "server_id": 0
        }, 
        "name": "string", 
        "operation": "string", 
        "postal_code": {
          "country_code": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string"
        }, 
        "region": {
          "country": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": "string", 
          "is_facebook_target": true, 
          "name": "string", 
          "name_localized": "string", 
          "region": "string"
        }
      }
    ], 
    "eid": "string"
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/adgroups/(adgroup)/geo-targets

Edit GeoTargets for the specified AdGroup.

Parameters:

Path Parameters
Name Required Type Description
adgroup True string AdGroup EID to add GeoTargets to.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

[
  {
    "eid": "string", 
    "operation": "string"
  }
]
Schema
Type:array

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "data": [
      {
        "city": {
          "country_code": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string", 
          "name_localized": "string", 
          "region_code": "string"
        }, 
        "country": {
          "code": "string", 
          "country": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string", 
          "server_id": 0
        }, 
        "geo_eid": "string", 
        "geo_type": "string", 
        "metro": {
          "boundaries": "string", 
          "country": "string", 
          "country_code": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string", 
          "server_id": 0
        }, 
        "name": "string", 
        "operation": "string", 
        "postal_code": {
          "country_code": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": 0, 
          "is_facebook_target": true, 
          "name": "string"
        }, 
        "region": {
          "country": "string", 
          "eid": "string", 
          "geo_type": "string", 
          "identifier": "string", 
          "is_facebook_target": true, 
          "name": "string", 
          "name_localized": "string", 
          "region": "string"
        }
      }
    ], 
    "eid": "string"
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/advertisables/(adv)/campaigns

Get campaigns for the given advertisable.

Parameters:

Path Parameters
Name Required Type Description
adv True string Advertisable EID to get campaigns from.
Query Parameters
Name Required Type Description
is_active False boolean  
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": [
    {
      "adgroups": [
        {
          "ads": [
            {
              "ad_eid": "string", 
              "adgroup_eid": "string", 
              "admin_status": "string", 
              "advertisable_eid": "string", 
              "campaign_eid": "string", 
              "campaign_name": "string", 
              "eid": "string", 
              "is_active": true, 
              "skip_approve_ad": true, 
              "status": "string"
            }
          ], 
          "advertisable_eid": "string", 
          "audience": {
            "adgroup_eid": "string", 
            "created_at": "string", 
            "eid": "string", 
            "size": 0, 
            "source_segment_eid": "string", 
            "target_segment_eid": "string", 
            "updated_at": "string"
          }, 
          "auto_audience": true, 
          "auto_geo_targets": true, 
          "campaign_eid": "string", 
          "created_at": "string", 
          "eid": "string", 
          "is_active": true, 
          "name": "string", 
          "status": "string", 
          "updated_at": "string"
        }
      ], 
      "admin_notes": "string", 
      "admin_status": "string", 
      "advertisable_eid": "string", 
      "bid_settings": {
        "bidding_mode": "string", 
        "vcpa": 0.0, 
        "vcpc": 0.0, 
        "vcpm": 0.0
      }, 
      "created_at": "string", 
      "currency_code": "string", 
      "eid": "string", 
      "end_date": "string", 
      "frequency_cap": 0, 
      "is_active": true, 
      "kpi_goal": 0.0, 
      "kpi_metric": "string", 
      "name": "string", 
      "source": "string", 
      "start_date": "string", 
      "status": "string", 
      "updated_at": "string", 
      "vcpc": 0.0, 
      "weekly_budget": "string"
    }
  ]
}
Schema
Type:object
results
Type:array of items
POST /prospecting/api/v2/advertisables/(adv)/campaigns

Create a campaign for the specified advertisable.

Parameters:

Path Parameters
Name Required Type Description
adv True string Advertisable EID to create the campaign for.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "admin_notes": "string", 
  "admin_status": "string", 
  "ads": "string", 
  "bid_settings": {
    "bidding_mode": "string", 
    "event_source": "fortyniner-ui", 
    "vcpa": 0.0, 
    "vcpc": 0.0, 
    "vcpm": 0.0
  }, 
  "campaign_strategy": "string", 
  "currency_code": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "frequency_cap": 0, 
  "is_active": true, 
  "kpi_goal": 0.0, 
  "kpi_metric": "string", 
  "name": "string", 
  "source": "49er", 
  "start_date": "string", 
  "user_status": "string", 
  "vcpc": 0.0, 
  "weekly_budget": "string"
}
Schema
Type:object
user_status
Type:string
Enum:active, paused, completed
event_source
Type:string
Default:fortyniner-ui
ads
Type:string
end_date
Type:string
is_active
Type:boolean
weekly_budget
Required:True
Type:string
campaign_strategy
Type:string
kpi_goal
Type:number
Format:float
frequency_cap
Type:integer
Format:int32
source
Type:string
Default:49er
admin_status
Type:string
Enum:review, rejected, paused, cancelled, active, completed
currency_code
Required:True
Type:string
bid_settings
Type:object
kpi_metric
Type:string
admin_notes
Type:string
start_date
Type:string
vcpc
Type:number
Format:float
name
Required:True
Type:string

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroups": [
      {
        "ads": [
          {
            "ad_eid": "string", 
            "adgroup_eid": "string", 
            "admin_status": "string", 
            "advertisable_eid": "string", 
            "campaign_eid": "string", 
            "campaign_name": "string", 
            "eid": "string", 
            "is_active": true, 
            "skip_approve_ad": true, 
            "status": "string"
          }
        ], 
        "advertisable_eid": "string", 
        "audience": {
          "adgroup_eid": "string", 
          "created_at": "string", 
          "eid": "string", 
          "size": 0, 
          "source_segment_eid": "string", 
          "target_segment_eid": "string", 
          "updated_at": "string"
        }, 
        "auto_audience": true, 
        "auto_geo_targets": true, 
        "campaign_eid": "string", 
        "created_at": "string", 
        "eid": "string", 
        "is_active": true, 
        "name": "string", 
        "status": "string", 
        "updated_at": "string"
      }
    ], 
    "admin_notes": "string", 
    "admin_status": "string", 
    "advertisable_eid": "string", 
    "bid_settings": {
      "bidding_mode": "string", 
      "vcpa": 0.0, 
      "vcpc": 0.0, 
      "vcpm": 0.0
    }, 
    "created_at": "string", 
    "currency_code": "string", 
    "eid": "string", 
    "end_date": "string", 
    "frequency_cap": 0, 
    "is_active": true, 
    "kpi_goal": 0.0, 
    "kpi_metric": "string", 
    "name": "string", 
    "source": "string", 
    "start_date": "string", 
    "status": "string", 
    "updated_at": "string", 
    "vcpc": 0.0, 
    "weekly_budget": "string"
  }
}
Schema
Type:object
results
Type:object
PATCH /prospecting/api/v2/advertisables/(adv)/campaigns

Change either user_status or currency_code (not both) for all campaigns belonging to the given advertisable. Completed or inactive campaigns won’t be affected when changing the user_status.

Parameters:

Path Parameters
Name Required Type Description
adv True string Advertisable EID associated with the patched campaigns.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "currency_code": "string", 
  "user_status": "string"
}
Schema
Type:object
user_status
Type:string
Enum:active, paused, completed
currency_code
Type:string

Responses:

200 OK

Schema as JSON:

{
  "results": [
    {
      "adgroups": [
        {
          "ads": [
            {
              "ad_eid": "string", 
              "adgroup_eid": "string", 
              "admin_status": "string", 
              "advertisable_eid": "string", 
              "campaign_eid": "string", 
              "campaign_name": "string", 
              "eid": "string", 
              "is_active": true, 
              "skip_approve_ad": true, 
              "status": "string"
            }
          ], 
          "advertisable_eid": "string", 
          "audience": {
            "adgroup_eid": "string", 
            "created_at": "string", 
            "eid": "string", 
            "size": 0, 
            "source_segment_eid": "string", 
            "target_segment_eid": "string", 
            "updated_at": "string"
          }, 
          "auto_audience": true, 
          "auto_geo_targets": true, 
          "campaign_eid": "string", 
          "created_at": "string", 
          "eid": "string", 
          "is_active": true, 
          "name": "string", 
          "status": "string", 
          "updated_at": "string"
        }
      ], 
      "admin_notes": "string", 
      "admin_status": "string", 
      "advertisable_eid": "string", 
      "bid_settings": {
        "bidding_mode": "string", 
        "vcpa": 0.0, 
        "vcpc": 0.0, 
        "vcpm": 0.0
      }, 
      "created_at": "string", 
      "currency_code": "string", 
      "eid": "string", 
      "end_date": "string", 
      "frequency_cap": 0, 
      "is_active": true, 
      "kpi_goal": 0.0, 
      "kpi_metric": "string", 
      "name": "string", 
      "source": "string", 
      "start_date": "string", 
      "status": "string", 
      "updated_at": "string", 
      "vcpc": 0.0, 
      "weekly_budget": "string"
    }
  ]
}
Schema
Type:object
results
Type:array of items
GET /prospecting/api/v2/advertisables/(adv)/settings

Get advertisable settings.

Parameters:

Path Parameters
Name Required Type Description
adv True string Advertisable EID to get settings for.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "advertisable": "string", 
    "ctc_weight": 1.0, 
    "ctc_window": 30, 
    "vtc_weight": 1.0, 
    "vtc_window": 30
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/advertisables/(adv)/settings

Edit advertisable settings.

Parameters:

Path Parameters
Name Required Type Description
adv True string Advertisable EID to edit settings for.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "ctc_window": 0, 
  "event_source": "fortyniner-ui", 
  "vtc_window": 0
}
Schema
Type:object
ctc_window

Click-through conversion window.

Type:integer
Format:int32
vtc_window

View-through conversion window.

Type:integer
Format:int32
event_source
Type:string
Default:fortyniner-ui

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "advertisable": "string", 
    "ctc_weight": 1.0, 
    "ctc_window": 30, 
    "vtc_weight": 1.0, 
    "vtc_window": 30
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/advertisables/(adv)/valid-segments

Returns the list of segment EIDs that can be used to create a Prospecting audience.

Parameters:

Path Parameters
Name Required Type Description
adv True string Advertisable EID to get segments from.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "advertisable_eid": "string", 
    "valid_segment_eids": [
      "string"
    ]
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/audiences/(audience)

Retrieve an audience with the specified EID.

Parameters:

Path Parameters
Name Required Type Description
audience True string Audience EID to get.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroup_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "size": 0, 
    "source_segment_eid": "string", 
    "target_segment_eid": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/audiences/(audience)

Edit audience by its EID.

Parameters:

Path Parameters
Name Required Type Description
audience True string Audience EID to edit.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "size": 0
}
Schema
Type:object
size
Type:integer
Format:int32

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroup_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "size": 0, 
    "source_segment_eid": "string", 
    "target_segment_eid": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/campaigns/(campaign)

Retrieve a campaign with the specified EID.

Parameters:

Path Parameters
Name Required Type Description
campaign True string Campaign EID to get.
Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
active_adgroups_only False boolean  
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroups": [
      {
        "ads": [
          {
            "ad_eid": "string", 
            "adgroup_eid": "string", 
            "admin_status": "string", 
            "advertisable_eid": "string", 
            "campaign_eid": "string", 
            "campaign_name": "string", 
            "eid": "string", 
            "is_active": true, 
            "skip_approve_ad": true, 
            "status": "string"
          }
        ], 
        "advertisable_eid": "string", 
        "audience": {
          "adgroup_eid": "string", 
          "created_at": "string", 
          "eid": "string", 
          "size": 0, 
          "source_segment_eid": "string", 
          "target_segment_eid": "string", 
          "updated_at": "string"
        }, 
        "auto_audience": true, 
        "auto_geo_targets": true, 
        "campaign_eid": "string", 
        "created_at": "string", 
        "eid": "string", 
        "is_active": true, 
        "name": "string", 
        "status": "string", 
        "updated_at": "string"
      }
    ], 
    "admin_notes": "string", 
    "admin_status": "string", 
    "advertisable_eid": "string", 
    "bid_settings": {
      "bidding_mode": "string", 
      "vcpa": 0.0, 
      "vcpc": 0.0, 
      "vcpm": 0.0
    }, 
    "created_at": "string", 
    "currency_code": "string", 
    "eid": "string", 
    "end_date": "string", 
    "frequency_cap": 0, 
    "is_active": true, 
    "kpi_goal": 0.0, 
    "kpi_metric": "string", 
    "name": "string", 
    "source": "string", 
    "start_date": "string", 
    "status": "string", 
    "updated_at": "string", 
    "vcpc": 0.0, 
    "weekly_budget": "string"
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/campaigns/(campaign)

Edit a campaign with the specified EID.

Parameters:

Path Parameters
Name Required Type Description
campaign True string Campaign EID to edit.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "admin_notes": "string", 
  "admin_status": "string", 
  "bid_settings": {
    "bidding_mode": "string", 
    "event_source": "fortyniner-ui", 
    "vcpa": 0.0, 
    "vcpc": 0.0, 
    "vcpm": 0.0
  }, 
  "currency_code": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "frequency_cap": 0, 
  "is_active": true, 
  "kpi_goal": 0.0, 
  "kpi_metric": "string", 
  "name": "string", 
  "source": "49er", 
  "start_date": "string", 
  "user_status": "string", 
  "vcpc": 0.0, 
  "weekly_budget": "string"
}
Schema
Type:object
user_status
Type:string
Enum:active, paused, completed
event_source
Type:string
Default:fortyniner-ui
name
Type:string
end_date
Type:string
is_active
Type:boolean
weekly_budget
Type:string
kpi_goal
Type:number
Format:float
frequency_cap
Type:integer
Format:int32
source
Type:string
Default:49er
admin_status
Type:string
Enum:review, rejected, paused, cancelled, active, completed
currency_code
Type:string
bid_settings
Type:object
admin_notes
Type:string
start_date
Type:string
vcpc
Type:number
Format:float
kpi_metric
Type:string

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroups": [
      {
        "ads": [
          {
            "ad_eid": "string", 
            "adgroup_eid": "string", 
            "admin_status": "string", 
            "advertisable_eid": "string", 
            "campaign_eid": "string", 
            "campaign_name": "string", 
            "eid": "string", 
            "is_active": true, 
            "skip_approve_ad": true, 
            "status": "string"
          }
        ], 
        "advertisable_eid": "string", 
        "audience": {
          "adgroup_eid": "string", 
          "created_at": "string", 
          "eid": "string", 
          "size": 0, 
          "source_segment_eid": "string", 
          "target_segment_eid": "string", 
          "updated_at": "string"
        }, 
        "auto_audience": true, 
        "auto_geo_targets": true, 
        "campaign_eid": "string", 
        "created_at": "string", 
        "eid": "string", 
        "is_active": true, 
        "name": "string", 
        "status": "string", 
        "updated_at": "string"
      }
    ], 
    "admin_notes": "string", 
    "admin_status": "string", 
    "advertisable_eid": "string", 
    "bid_settings": {
      "bidding_mode": "string", 
      "vcpa": 0.0, 
      "vcpc": 0.0, 
      "vcpm": 0.0
    }, 
    "created_at": "string", 
    "currency_code": "string", 
    "eid": "string", 
    "end_date": "string", 
    "frequency_cap": 0, 
    "is_active": true, 
    "kpi_goal": 0.0, 
    "kpi_metric": "string", 
    "name": "string", 
    "source": "string", 
    "start_date": "string", 
    "status": "string", 
    "updated_at": "string", 
    "vcpc": 0.0, 
    "weekly_budget": "string"
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/campaigns/(campaign)/adgroups

Get AdGroups that belong to given campaign.

Parameters:

Path Parameters
Name Required Type Description
campaign True string Campaign EID to get AdGroups from.
Query Parameters
Name Required Type Description
is_active False boolean  
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": [
    {
      "ads": [
        {
          "ad_eid": "string", 
          "adgroup_eid": "string", 
          "admin_status": "string", 
          "advertisable_eid": "string", 
          "campaign_eid": "string", 
          "campaign_name": "string", 
          "eid": "string", 
          "is_active": true, 
          "skip_approve_ad": true, 
          "status": "string"
        }
      ], 
      "advertisable_eid": "string", 
      "audience": {
        "adgroup_eid": "string", 
        "created_at": "string", 
        "eid": "string", 
        "size": 0, 
        "source_segment_eid": "string", 
        "target_segment_eid": "string", 
        "updated_at": "string"
      }, 
      "auto_audience": true, 
      "auto_geo_targets": true, 
      "campaign_eid": "string", 
      "created_at": "string", 
      "eid": "string", 
      "is_active": true, 
      "name": "string", 
      "status": "string", 
      "updated_at": "string"
    }
  ]
}
Schema
Type:object
results
Type:array of items
POST /prospecting/api/v2/campaigns/(campaign)/adgroups

Create an AdGroup for the given campaign.

Parameters:

Path Parameters
Name Required Type Description
campaign True string Campaign EID to add AdGroup to.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "ads": [
    {
      "ad_eid": "string", 
      "admin_status": "string", 
      "event_source": "fortyniner-ui", 
      "is_active": true, 
      "skip_approve_ad": true, 
      "user_status": "string"
    }
  ], 
  "auto_audience": true, 
  "auto_geo_targets": true, 
  "event_source": "fortyniner-ui", 
  "is_active": true, 
  "name": "string", 
  "user_status": "string"
}
Schema
Type:object
user_status
Type:string
Enum:active, paused
event_source
Type:string
Default:fortyniner-ui
ads
Type:array of items
is_active
Type:boolean
name
Type:string
auto_geo_targets
Type:boolean
auto_audience
Type:boolean

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "ads": [
      {
        "ad_eid": "string", 
        "adgroup_eid": "string", 
        "admin_status": "string", 
        "advertisable_eid": "string", 
        "campaign_eid": "string", 
        "campaign_name": "string", 
        "eid": "string", 
        "is_active": true, 
        "skip_approve_ad": true, 
        "status": "string"
      }
    ], 
    "advertisable_eid": "string", 
    "audience": {
      "adgroup_eid": "string", 
      "created_at": "string", 
      "eid": "string", 
      "size": 0, 
      "source_segment_eid": "string", 
      "target_segment_eid": "string", 
      "updated_at": "string"
    }, 
    "auto_audience": true, 
    "auto_geo_targets": true, 
    "campaign_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "is_active": true, 
    "name": "string", 
    "status": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/campaigns/(campaign)/geo-targets

Retrieve GeoTargets for the specified Campaign.

Parameters:

Path Parameters
Name Required Type Description
campaign True string Campaign EID to get GeoTargets from.
Query Parameters
Name Required Type Description
active_adgroups_only False boolean  
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": [
    {
      "adgroup": "string", 
      "geotargets": [
        {
          "city": {
            "country_code": "string", 
            "eid": "string", 
            "geo_type": "string", 
            "identifier": 0, 
            "is_facebook_target": true, 
            "name": "string", 
            "name_localized": "string", 
            "region_code": "string"
          }, 
          "country": {
            "code": "string", 
            "country": "string", 
            "eid": "string", 
            "geo_type": "string", 
            "identifier": 0, 
            "is_facebook_target": true, 
            "name": "string", 
            "server_id": 0
          }, 
          "geo_eid": "string", 
          "geo_type": "string", 
          "metro": {
            "boundaries": "string", 
            "country": "string", 
            "country_code": "string", 
            "eid": "string", 
            "geo_type": "string", 
            "identifier": 0, 
            "is_facebook_target": true, 
            "name": "string", 
            "server_id": 0
          }, 
          "name": "string", 
          "operation": "string", 
          "postal_code": {
            "country_code": "string", 
            "eid": "string", 
            "geo_type": "string", 
            "identifier": 0, 
            "is_facebook_target": true, 
            "name": "string"
          }, 
          "region": {
            "country": "string", 
            "eid": "string", 
            "geo_type": "string", 
            "identifier": "string", 
            "is_facebook_target": true, 
            "name": "string", 
            "name_localized": "string", 
            "region": "string"
          }
        }
      ]
    }
  ]
}
Schema
Type:object
results
Type:array of items
PUT /prospecting/api/v2/flights/(flight)

Edit a Flight.

Parameters:

Path Parameters
Name Required Type Description
flight True string Flight EID to edit.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
start_date

Flight start date.

Type:string
end_date

Flight end date.

Type:string

Responses:

200 OK

Flight edited successfully.

Schema as JSON:

{
  "results": {
    "adgroup_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "end_date": "string", 
    "start_date": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
400 Bad Request

The Flight was not edited.

  • Your Flight might be missing start/end dates.
  • The start date might be greater than the end date.
  • Your Flight might be overlapping with another of the adgroup’s Flights.

Schema as JSON:

{
  "code": 0, 
  "message": "string"
}
Schema
Type:object
message

String, list, or dictionary of error messages. If a dictionary, the keys will be field names and the values will be lists of messages.

Type:string
code

HTTP error code.

Type:integer
Format:int32
DELETE /prospecting/api/v2/flights/(flight)

Delete a Flight.

Parameters:

Path Parameters
Name Required Type Description
flight True string Flight EID to delete.
Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "event_source": "fortyniner-ui"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "adgroup_eid": "string", 
    "created_at": "string", 
    "eid": "string", 
    "end_date": "string", 
    "start_date": "string", 
    "updated_at": "string"
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/metrics/adgroup-ads

Get performance metrics for a list of AdGroup ads.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
start_date True string Start date for query range.
end_date True string End date for query range.
adgroup_ad_eids True string Comma-separated list of AdGroup ad EIDs to get metrics for.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/metrics/adgroup-ads

Get performance metrics for a list of AdGroup ads.

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "adgroup_ad_eids": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
adgroup_ad_eids

Comma-separated list of AdGroup ad EIDs to get metrics for.

Required:True
Type:string
end_date

End date for query range.

Required:True
Type:string
Format:date
start_date

Start date for query range.

Required:True
Type:string
Format:date

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/metrics/adgroups

Get performance metrics for a list of AdGroups.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
start_date True string Start date for query range.
end_date True string End date for query range.
adgroup_eids True string Comma-separated list of AdGroup EIDs to get metrics for.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/metrics/adgroups

Get performance metrics for a list of AdGroups.

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "adgroup_eids": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
adgroup_eids

Comma-separated list of AdGroup EIDs to get metrics for.

Required:True
Type:string
end_date

End date for query range.

Required:True
Type:string
Format:date
start_date

Start date for query range.

Required:True
Type:string
Format:date

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/metrics/advertisables

Get performance metrics for an advertisable.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
advertisable_eid True string Advertisable EID.
start_date True string Start date for query range.
end_date True string End date for query range.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/metrics/advertisables

Get performance metrics for an advertisable.

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "advertisable_eid": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "start_date": "string"
}
Schema
Type:object
advertisable_eid

Advertisable EID.

Required:True
Type:string
MaxLength:22
MinLength:22
event_source
Type:string
Default:fortyniner-ui
start_date

Start date for query range.

Required:True
Type:string
Format:date
end_date

End date for query range.

Required:True
Type:string
Format:date

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/metrics/campaigns

Get performance metrics for a list of campaigns.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
start_date True string Start date for query range.
end_date True string End date for query range.
campaign_eids True string Comma-separated list of campaign EIDs to get metrics for.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
POST /prospecting/api/v2/metrics/campaigns

Get performance metrics for a list of campaigns.

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "campaign_eids": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
campaign_eids

Comma-separated list of campaign EIDs to get metrics for.

Required:True
Type:string
end_date

End date for query range.

Required:True
Type:string
Format:date
start_date

Start date for query range.

Required:True
Type:string
Format:date

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "items": [
      {
        "daily": [
          {
            "assisted_convs": 0, 
            "bounce": 0, 
            "date": "string", 
            "direct_ctc": 0, 
            "direct_ctc_windowed": 0, 
            "direct_vtc": 0, 
            "direct_vtc_windowed": 0, 
            "engaged": 0, 
            "new": 0, 
            "nonbounce": 0, 
            "total_ctc": 0, 
            "total_vtc": 0
          }
        ], 
        "eid": "string", 
        "summary": {
          "assisted_convs": 0, 
          "bounce": 0, 
          "direct_ctc": 0, 
          "direct_ctc_windowed": 0, 
          "direct_vtc": 0, 
          "direct_vtc_windowed": 0, 
          "engaged": 0, 
          "new": 0, 
          "nonbounce": 0, 
          "total_ctc": 0, 
          "total_vtc": 0
        }
      }
    ], 
    "meta": {
      "end_date": "string", 
      "start_date": "string"
    }
  }
}
Schema
Type:object
results
Type:object
GET /prospecting/api/v2/report/ad

Get ad report from the AdRoll Reporting API.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
data_format False string  
start_date False string  
end_date False string  
currency False string  
show_empty False string  
_escape False string  
legacy_adgroup_eids False string Legacy AdGroup EIDs.
adgroup_eids False string Prospecting AdGroup EIDs.
ad_eids False string Ad EIDs.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

The response will follow the AdRoll Reporting API response structure.

Schema as JSON:

"Unknown type"
Schema
POST /prospecting/api/v2/report/ad

Get ad report from the AdRoll Reporting API.

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "_escape": "string", 
  "ad_eids": "string", 
  "adgroup_eids": "string", 
  "currency": "string", 
  "data_format": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "legacy_adgroup_eids": "string", 
  "show_empty": "string", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
adgroup_eids

Prospecting AdGroup EIDs.

Type:string
end_date
Type:string
show_empty
Type:string
data_format
Type:string
_escape
Type:string
ad_eids

Ad EIDs.

Type:string
currency
Type:string
legacy_adgroup_eids

Legacy AdGroup EIDs.

Type:string
start_date
Type:string

Responses:

200 OK

The response will follow the AdRoll Reporting API response structure.

Schema as JSON:

"Unknown type"
Schema
GET /prospecting/api/v2/report/adgroup

Get AdGroup report from the AdRoll Reporting API.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
data_format False string  
start_date False string  
end_date False string  
currency False string  
show_empty False string  
_escape False string  
legacy_adgroup_eids False string Legacy AdGroup EIDs.
adgroup_eids False string Prospecting AdGroup EIDs.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

The response will follow the AdRoll Reporting API response structure.

Schema as JSON:

"Unknown type"
Schema
POST /prospecting/api/v2/report/adgroup

Get AdGroup report from the AdRoll Reporting API.

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "_escape": "string", 
  "adgroup_eids": "string", 
  "currency": "string", 
  "data_format": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "legacy_adgroup_eids": "string", 
  "show_empty": "string", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
adgroup_eids

Prospecting AdGroup EIDs.

Type:string
end_date
Type:string
show_empty
Type:string
data_format
Type:string
_escape
Type:string
currency
Type:string
legacy_adgroup_eids

Legacy AdGroup EIDs.

Type:string
start_date
Type:string

Responses:

200 OK

The response will follow the AdRoll Reporting API response structure.

Schema as JSON:

"Unknown type"
Schema
GET /prospecting/api/v2/report/assisted

Get prospecting assisted report for the given advertisable.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
advertisable_eid True string Advertisable EID.
start_date True string Start date for query range.
end_date True string End date for query range.
data_format False string Data format desired for the response. One of: json, csv. Default: csv.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Depending on the data_format you specified, the response will be either:

  • JSON: Dict of the form {“results”: [{: , ...}, ...]}.
  • CSV: Streamed CSV file.

Schema as JSON:

"Unknown type"
Schema
GET /prospecting/api/v2/report/campaign

Get campaign report from the AdRoll Reporting API.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
data_format False string  
start_date False string  
end_date False string  
currency False string  
show_empty False string  
_escape False string  
legacy_campaign_eids False string Legacy campaign EIDs.
campaign_eids False string Prospecting campaign EIDs.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

The response will follow the AdRoll Reporting API response structure.

Schema as JSON:

"Unknown type"
Schema
POST /prospecting/api/v2/report/campaign

Get campaign report from the AdRoll Reporting API.

Parameters:

Query Parameters
Name Required Type Description
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Schema for request body:

{
  "_escape": "string", 
  "campaign_eids": "string", 
  "currency": "string", 
  "data_format": "string", 
  "end_date": "string", 
  "event_source": "fortyniner-ui", 
  "legacy_campaign_eids": "string", 
  "show_empty": "string", 
  "start_date": "string"
}
Schema
Type:object
event_source
Type:string
Default:fortyniner-ui
end_date
Type:string
show_empty
Type:string
campaign_eids

Prospecting campaign EIDs.

Type:string
data_format
Type:string
currency
Type:string
legacy_campaign_eids

Legacy campaign EIDs.

Type:string
_escape
Type:string
start_date
Type:string

Responses:

200 OK

The response will follow the AdRoll Reporting API response structure.

Schema as JSON:

"Unknown type"
Schema
GET /prospecting/api/v2/report/gcr

Get prospecting GCR report for the given advertisable.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
advertisable_eid True string Advertisable EID.
start_date True string Start date for query range.
end_date True string End date for query range.
data_format False string Data format desired for the response. One of: json, csv. Default: csv.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Depending on the data_format you specified, the response will be either:

  • JSON: Dict of the form {“results”: [{: , ...}, ...]}.
  • CSV: Streamed CSV file.

Schema as JSON:

"Unknown type"
Schema
GET /prospecting/api/v2/report/insights

Get insights report for the given advertisable.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
advertisable_eid True string Advertisable EID.
start_date False string Start date for query range. Defaults to 30 days prior end_date.
end_date True string End date for query range.
reports True string Comma-separated list of report types.
locale False string Locale to get the report in, if available.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

The response will contain a downloadable PDF.

Schema as JSON:

"Unknown type"
Schema
GET /prospecting/api/v2/reports/campaign

Get prospecting report for the given campaigns.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
advertisable_eid False string Advertisable EID.
start_date True string Start date for query range.
end_date True string End date for query range.
campaign_eids False string EIDs of campaigns to include.
data_format True string The format of the response, possible values are (json, csv, xls). One of: json, csv, xls.
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Depending on the data_format you specified, the response will be either:

  • JSON: Dict of the form {“results”: [{: , ...}, ...]}.
  • XLS: Streamed XLS file.
  • CSV: Streamed CSV file.

Schema as JSON:

"Unknown type"
Schema
GET /prospecting/api/v2/reports/insights-data

Get insights data for the given advertisable.

Parameters:

Query Parameters
Name Required Type Description
event_source False string Default: fortyniner-ui.
advertisable_eid True string Advertisable EID.
start_date False string Insights data start date (inclusive)
end_date False string Insights data end date (inclusive)
date False string Insights data end date (inclusive). Start date is 30 days before this. (deprecated in favor of start_date and end_date)
apikey False string Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the AdRoll Developer site

Responses:

200 OK

Schema as JSON:

{
  "results": {
    "us_traffic_ratio": 0.0
  }
}
Schema
Type:object
results
Type:object