Campaign Methods
Get Campaign Info
This endpoint provides information for a given campaign if specified, otherwise it will return all campaigns, regardless of status.
Caution
- Some of these endpoints require your campaign ID, which can be found at the end of your campaign's URL.
- The
bid_idis 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 | 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 |
promote_in | Publishing app ID(s) | Publishers |
status | Current campaign status: active, paused, archived | Everyone |
Updated 6 months ago