Charboost API — Campaign Methods

Last Update:
Some of these endpoints require your campaign ID. Where is my campaign ID?

 

 

This endpoint provides information for a given campaign if specified, otherwise it will return all campaigns, regardless of status.

The bid_id is provided in the response here which can be used for the endpoints below.

HTTP method GET
Endpoint https://api.chartboost.com/campaigns
Example Request https://api.chartboost.com/campaigns/?user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}

Parameters
Parameter Request Type Required? Description Default
campaign_id String Optional A single campaign ID All

Response Fields
Parameter Description Returned for...
app_id Advertising app ID Advertiser
bids Campaign target ID(s); bid_id for endpoints below Everyone
campaign_type marketplace, directdeal, crosspromotion Everyone
date_created Date campaign was created (UNIX timestamp) Everyone
date_max Campaign end date, if set (UNIX timestamp) Everyone
date_min Campaign start date, if set (UNIX timestamp) Everyone
date_modified Date campaign was last modified (UNIX timestamp) Everyone
id Campaign ID Everyone
name Campaign name Everyone
platform ios, google_play, amazon Everyone
priority Current campaign show priority Everyone
promote_in Publishing app ID(s) Publishers
status Current campaign status: active, paused, archived Everyone

▲ Back to top

 

This endpoint returns detailed information about a given bid if specified within a campaign; otherwise, all of the campaign's bids are returned. The /bid endpoint is used for Get Bid Info and all of the following methods.


HTTP method GET
Endpoint https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
Example Request https://api.chartboost.com/campaigns/?{{Campaign ID}}/bid/{{Bid ID}}?campaign_id={{Campaign ID}}&bid_id={{Bid ID}}&user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}


Parameters
Parameter Request Type Required? Description Default
bid_id String Optional A single (target) bid ID All
campaign_id String Required A single campaign ID N/A

Response Fields
Parameter Description Returned for...
app_filter Deprecated Everyone
app_toggle Deprecated Everyone
bid_amount $USD bid amount Advertisers
bid_id Bid ID Everyone
bid_type Advertising bid type
Learn more about bid types ▶
Advertisers
budget Total daily budget of the bid (target) Advertisers
device_filter Device(s) by series or model selected in targeting Everyone
device_toggle true = include; false = exclude Everyone
expire_date Date when bid will expire in Direct Deals (UNIX timestamp) Everyone
is_enabled Determines whether bid (target) is enabled: true, false Everyone
location_filter Countries selected in targeting Everyone
location_toggle true = include; false = exclude Everyone
os_filter Operating system(s) selected in targeting: max = Maximum version; min = Minimum version Everyone
title Bid (target) name Everyone

▲ Back to top

 

This method allows for an existing bid to be edited. Only a single bid can be edited per request.


HTTP method PUT
Endpoint https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
Example Request See code below

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}

Request Body:
{
    "campaign_id": {{Campaign ID}},
    "bid_id": {{Bid ID}},
    "user_id": {{Chartboost customer's user ID}},
    "user_signature": {{CB customer's user signature}}
}
				

Parameters
Parameter Request Type Required? Description Default
bid_amount Number Optional $USD bid amount (e.g. "0.55")
Note: bid_type must also be set when updating the amount.
N/A
bid_id String Required A single (target) bid ID N/A
bid_type String Optional, but required with bid_amount Bid type (CPC or CPI) N/A
budget Number Optional $USD daily budget for this bid N/A
campaign_id String Required A single campaign ID N/A
device_filter String Optional A comma-separated list of device types (e.g. "iphone,ipod touch,ipad") N/A
device_toggle Boolean Optional Operator for list in device_filter;
true if exclude
false or absent for include
false (include)
is_enabled Boolean Optional A toggle to enable or disable the bid;
true = enable, false = disable
N/A
location_filter String Optional A comma-separated list of two character country codes (e.g. "US,CA"); if blank, will default to all countries.
Note: location_toggle must also be set when updating country filter.
N/A
location_toggle Boolean Optional, but required with location_filter true if location_filter is whitelist (i.e. target only these countries);
false if location_filter is blacklist (i.e. target all countries but these).
N/A
os_filter_max Number Optional Maximum OS version (e.g. 8.0) N/A
os_filter_min Number Optional Minimum OS version (e.g. 4.3) N/A

Response Fields
Parameter Description Returned for...
app_filter Deprecated Everyone
app_toggle Deprecated Everyone
bid_amount $USD bid amount Advertisers
bid_id Bid ID Everyone
bid_type Bid type (CPC or CPI)
Learn more about bid types ▶
Advertisers
budget $USD daily budget for this bid Advertisers
device_filter List of device types Everyone
device_toggle true = exclude; false = include Everyone
expire_date Date when bid will expire in Direct Deals (UNIX timestamp) Everyone
is_enabled Determines if bid is active;
true = enable
false = disable
Everyone
location_filter List of countries Everyone
location_toggle true = include; false = exclude Everyone
os_filter min = minimum OS version; max = maximum OS versions Everyone
title Target (bid) name Everyone

▲ Back to top

 

This method is solely for advertising campaigns and allows you to create new bids within a campaign. The new bid's title will match the bid ID but can be renamed in your dashboard.


HTTP method POST
Endpoint https://api.chartboost.com/campaigns/{{Campaign ID}}/bid
Example Request See code below

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid

Request Body:
{
    "campaign_id": {{Campaign ID}},
    "bid_amount": {{Bid Amount}},
    "bid_type": {{Bid Type}},
    "user_id": {{Chartboost customer's user ID}},
    "user_signature": {{CB customer's user signature}}
}
				

Parameters
Parameter Request Type Required? Description Default
bid_amount Number Required $USD bid amount (e.g. "0.55")
Note: bid_type must also be set when updating the amount
N/A
bid_type String Required Bid type (CPC or CPI) N/A
budget Number Required $USD daily budget for this bid N/A
campaign_id String Required A single campaign ID N/A
device_filter String Optional A comma-separated list of device types (e.g. "iphone,ipod touch,ipad") N/A
device_toggle Boolean Optional Operator for list in device_filter
true if exclude
false or absent for include
false (include)
is_enabled Boolean Optional A toggle to enable/disable the bid
true = enable false = disable
N/A
location_filter String Optional A comma-separated list of two character country codes (e.g. "US, CA"); if blank, will default to all countries
Note: location_toggle must also be set when updating country filter
N/A
location_toggle Boolean Optional, but required with location_filter true if location_filter is whitelist (i.e. target only these countries)
false if location_filter is blacklist (i.e. target all countries but these)
N/A
os_filter_max Number Optional Maximum OS version (e.g. 8.0) N/A
os_filter_min Number Optional Minimum OS version (e.g. 4.3) N/A

Response Fields
Parameter Description Returned for...
app_filter Deprecated Everyone
app_toggle Deprecated Everyone
bid_amount $USD bid amount Advertisers
bid_id Bid ID Everyone
bid_type Bid type (CPC or CPI)
Learn more about bid types ▶
Advertisers
budget $USD daily budget for this bid Advertisers
device_filter List of device types Everyone
device_toggle true = exclude; false = include Everyone
expire_date Date when bid will expire in Direct Deals (UNIX timestamp) Everyone
is_enabled Determines if bid is active;
true = enable
false = disable
Everyone
location_filter List of countries Everyone
location_toggle true = include; false = exclude Everyone
os_filter min = minimum OS version; max = maximum OS versions Everyone
title Target (bid) name Everyone

▲ Back to top

 


You might also like...