API

Using the Kintura API to manage your tracker.


Making Requests

Current API is available at https://yourinstance.kintura.io/1.0/

All you need to do to authenticate is pass "X-Api-Key" and "X-Api-Secret" request headers along with your request. If you're doing this with php's curl library, just copy the code to the clipboard by clicking <> next to the API key/secret pair you wish to use. A working code example will be copied to your clipboard.

Common Request Parameters

Any time you GET a resource's index (i.e. GET /1.0/campaigns) you can pass query string parameters page=1 and per_page=20 to determine which page of results you want along with how many results you want per page respectively. You can also ?search=foobar to search title fields on entities with a title parameter.

Common Response Headers

Pagination results are also included on index endpoints. The headers X-Current-Page, X-Total-Count and X-Total-Pages will indicate the current page, the total number of records and the total number of pages respectively.

Limits

Requests across the Kintura infrastructure are typically throttled to one per second. Maximum items per page is 50. If you have more questions about limits, please file a ticket within the instance in question.

Campaigns

Create and manage campaigns

Parameter Rules
title required: YES
max: 100
guid required: YES
traffic_source_id required: YES
exists: YES
region_id null: YES
exists: YES
cost_model options: none,cpc,cpa,auto,cpm,rev
routing_mode options: allSticky,rotateRoutes,stickyRoutes,rotateOffers,rotateLandingPages
cost_value required: YES
use_prodigy
is_active null: YES

GET /campaigns
GET /campaigns/{id}
POST /campaigns
PUT /campaigns/{id}
DELETE /campaigns/{id}

Routes

Manage routes. Here we're just creating a saved route and getting ready to add targets (landing pages/offers).

Parameter Rules
title required: YES
max: 100
is_direct
force_redirect_mode null: YES
options: doubleMeta,meta,302

GET /routes
POST /routes
PUT /routes/{id}
DELETE /routes/{id}

Campaign Routes

Create and manage campaign routes. This is how we attach routes to campaigns. If a filter_id is provided, it's what we call a Filtered Campaign Route.

Parameter Rules
campaign_id required: YES
exists: YES
route_id exists: YES
filter_id null: YES
exists: YES
weight null: YES
order null: YES

GET /campaign_routes
GET /campaign_routes/{id}
POST /campaign_routes
PUT /campaign_routes/{id}
DELETE /campaign_routes/{id}

Route Targets

Route Targets are either landing pages or offers attached to routes.

Parameter Rules
route_id required: YES
exists: YES
weight required: YES
min: 1
max: 100
target_type required: YES
options: Offer,LandingPage
target_id required: YES
exists: YES
redirect_mode required: YES
options: doubleMeta,meta,302

GET /route_targets
GET /route_targets/{id}
POST /route_targets
PUT /route_targets/{id}
DELETE /route_targets/{id}

Landing Pages

Landing page management.

Parameter Rules
title required: YES
max: 100
url required: YES

GET /landing_pages
GET /landing_pages/{id}
POST /landing_pages
PUT /landing_pages/{id}
DELETE /landing_pages/{id}

Offers

Offer management.

Parameter Rules
title required: YES
max: 100
url required: YES
affiliate_network_id required: YES
exists: YES
auto_payout required: YES
manual_payout required: YES
cap_enabled
cap_limit required: YES
null: YES
cap_tz_id required: YES
null: YES
exists: YES
cap_offer_id required: YES
null: YES
exists: YES

GET /offers
GET /offers/{id}
POST /offers
PUT /offers/{id}
DELETE /offers/{id}

Affiliate Networks

Affiliate Network management.

Parameter Rules
title required: YES
max: 120
accept_duplicate_postbacks
require_ip_whitelist
ip_whitelist required: YES

GET /affiliate_networks
GET /affiliate_networks/{id}
POST /affiliate_networks
PUT /affiliate_networks/{id}
DELETE /affiliate_networks/{id}

Traffic Sources

Traffic Source management. Note: 'alias' must be alias in traffic_source_templates.

Parameter Rules
alias null: YES
title required: YES
postback_url null: YES

GET /traffic_sources
GET /traffic_sources/{id}
POST /traffic_sources
PUT /traffic_sources/{id}
DELETE /traffic_sources/{id}

Traffic Source Templates

Traffic Source management. Note: 'alias' must be alias in traffic_source_templates.

Parameter Rules
alias null: YES
title required: YES
postback_url null: YES

GET /traffic_source_templates
GET /traffic_source_templates/{alias}