Support Home > Analytics, Reports & API > Premium Publisher API Campaign Management

Premium Publisher API Campaign Management


The Kochava platform provides extensive tools to track everything from impressions thru post-install events for connected devices. The Campaign Management API Integration provides the programmatic tools to create and maintain campaigns, segments and trackers.


Get Campaigns List

This API provides the ability to retrieve the entire list of campaigns from the numerical App ID provided in the URL.

 

Parameters Description Format
app_id App_id that the campaign is associated with. Example: 123. String
stats Whether to include number_of_trackers and number_of_tiers. Example: true. Boolean

 

Sample Request:

 

Sample Response:


Create a Campaign

This API is used to create a new campaign by providing a JSON definition of the campaign.

 

Parameters Description Format
app_id App_id that the campaign is associated with. Example: 123. String

 

Sample Request:

 

Sample Response:


Update a Campaign

This API is used to update an existing campaign by providing a JSON definition of the campaign with the modifications. If the campaign is successfully updated an HTTP 200 code and response, as shown below, is returned.

 

Parameters Description Format
app_id App_id that the campaign is associated with. Example: 123. String

 

Sample Request:

 

Sample Response:


Get Campaign by ID

This API provides the ability to retrieve a single campaign for the numerical Campaign ID provided in the URL.

 

Parameters Description Format
app_id App_id that the campaign is associated with. Example: 123. String
campaign_id The campaign associated with this campaign_id are returned. Example: 123 . Boolean

 

Sample Request:

 

Sample Response:


Get Segments

This API provides the ability to retrieve the segments for the numerical Campaign ID provided in the URL.

 

Parameters Description Format
campaign_id Segments associated with this campaign_id are returned. Example: 123. String

 

Sample Request:

 

Sample Response:


Create a Segment

This API is used to create a new segment by providing a JSON definition of the segment.

 

Parameters Description Format
campaign_id Segment will be created within the designated campaign_id. Example: 123. String

 

Sample Request:

 

Sample Response:


Update a Segment

This API is used to update an existing segment by providing a JSON definition of the segment with the modifications. If the segment is successfully updated an HTTP 200 code and response, as shown below, is returned.

 

Parameters Description Format
campaign_id Segment will be updated within the designated campaign_id. Example: 123. String

 

Sample Request:

 

Sample Response:


Get Segment by ID

This API provides the ability to retrieve a single segment for the numerical Segment ID provided in the URL.

 

Parameters Description Format
campaign_id Designated campaign which contains the desired segment. Example: 123. String
tier_id Segment will be returned with the designated tier_id. Example: 123. String

 

Sample Request:

 

Sample Response:


Get Trackers

This API provides the ability to retrieve the entire list of trackers for the numerical App ID provided in the URL.

 

Parameters Description Format
app_id App_id that the trackers are associated with. Example: 123. String
tracker_ids Comma seperated list of trackers to return. Example: 123,456. String
editable whether to just include non-SAN, non-Smartlink trackers. Example: true. Boolean
network_name Include only results from this network. Example: Applovin - iOS. String
campaign_name Include only results from this campaign. Example: Demo Campaign. String
tier_name Include only results from this tier. Example: Default Tier. String
network_pricing Include only results with this price type. Example: cpi. String
type Include only results of this type. Example: type_url_forward. String
network_name_not Exclude results from this. Example: Applovin - iOS. String
campaign_name_not Exclude results from this campaign. Example: Demo Campaign. String
tier_name_not Exclude results from this tier. Example: Default Tier. String
network_pricing_not Exclude results with this price type. Example: cpc. String
type_not Exclude results with this type. Example: type_url_forward. String
traffic_verification Include or exclude trackers with traffic verification rules. Example: true. String
tracker_overrides Include or exclude trackers with override rules. Example: true. String
campaign_ids Include these campaign ids in the results. Example: 1,2. String
tier_ids Include these tier ids in the results. Example: 1,2.

 

Sample Request:

 

Sample Response:


Update Trackers

This API is used to update an existing tracker by providing a JSON definition of the tracker with modifications. If the tracker is successfully updated an HTTP 200 code and response, as shown below, is returned.

 

Parameters Description Format
app_id App_id that the trackers are associated with. Example: 123. String

 

Sample Request:

 

Sample Response:


Delete a Tracker

This API is used to delete an existing tracker by providing the numerical Tracker ID. If the tracker is deleted an HTTP 200 response will be returned, otherwise another HTTP code and message detailing the error will be returned.

 

Parameters Description Format
app_id App_id that the trackers are associated with. Example: 123. String
tracker_id Comma seperated list of trackers to return. Example: 123. String

 

Sample Request:

 

Sample Response:


Create a Tracker

This API is used to create a new tracker by providing a JSON definition of the tracker.

 

Parameters Description Format
app_id App_id that the tracker will be associated with. Example: 123. String

 

Sample Request:

 

Sample Response:


Get Tracker Overrides

This API provides the ability to retrieve the tracker overrides for the numerical Override ID provided in the URL.

 

Parameters Description Format
tracker_id Designated tracker which the tracker overrides will be returned. Example: 123. String

 

Sample Request:

 

Sample Response:


Post Tracker Overrides

This API provides the ability to create tracker overrides for the numerical Tracker ID provided in the URL.

 

Parameters Description Format
tracker_id Designated tracker which the tracker overrides will be created for. Example: 123. String

 

Sample Request:

 

Sample Response:

 
 

Last Modified: Oct 10, 2017 at 1:45 pm