YieldKit provides a HTTP API that provides incentives. Requests are made via an HTTP GET request in the form of:
http://api.yieldkit.com/v1/method[?parameters]
Incentive Method
http://api.yieldkit.com/v1/incentive?
api_key=<your_api_key>&
api_secret=<your_api_secret>&
site_id=<site id>&
valid_from=<valid_from>&
valid_to=<valid_to>&
country=<country>&
q=<query>&
page_size=<page size>&
page=<page>&
format=<format>&
category_id=<category_id>&
language=<language>
PARAMETERS:
Parameter | Description |
---|---|
api_key / api_secret | Find your API Key / API secret on http://www.yieldkit.com/account under the API tab |
site_id | Find the Site ID of the website you want to check on http://www.yieldkit.com/account under the Your Sites tab |
valid_from / valid_to (optional) | Start / End date of the report. Format: yyyy-MM-dd |
country (optional) | ISO2 Code, e.g. US, UK or DE |
q (=query) (optional) | Keyword filter / Search query for advertiser name, domain, f.e. „Groupon Jamaica“, replace spaces („ “) with „+“ („Groupon Jamaica“ -> „Groupon+Jamaica“) |
page_size | Number of results per page (Default: 10, Maximum: 100) |
page | Number of page, starting at 1 |
format | csv or json |
category_id (optional) | Limits the incentives to be within a certain category. Please use the numeric codes as listed in the table below. |
language (optional) | Limits the incentives to be within a certain language. Please use the two letter ISO 639-1 codes as can be found here. |
Category IDs
Numeric Code | Category |
1 | Automotive |
2 | Baby & Kids |
3 | Books, News & Magazines |
4 | Clothing, Shoes, Jewlery |
5 | Department Stores |
6 | Electronics & Computers |
7 | Finance & Utilities |
8 | Flowers |
9 | Food & Grocery |
10 | Gifts & Collectibles |
11 | Health & Beauty |
12 | Holidays & Travel |
13 | Home & Garden |
14 | Leisure |
15 | Movies, Music & Entertainment |
16 | Office |
17 | Pet Care & Supplies |
18 | Phones |
19 | Services |
20 | Software & Apps |
21 | Toys & Games |
22 | Adult |
23 | Sports & Outdoors |
24 | Betting |
EXAMPLE:
http://api.yieldkit.com/v1/incentive?api_key=c5c2398597a6adcd9b149ad745f207f4&
api_secret=74607007cdb6b0db4b3219c8adee3e09&
site_id=50880c31e4b0f12859e3c14b&
valid_from=2013-01-01&
valid_to=2013-01-31&
country=US&
q=Groupon+Jamaica&
page_size=10&
page=1&
format=csv
SAMPLE RESPONSE CSV:
Id;Advertiser;Description;Name;Code;Valid from;Valid to;Tracking link
50add79cda0639c6b787c621;
Groupon US;
4- or 7-Night All-Inclusive Stay for Two. Combine Up to 21 Nights. Starting at $999 Total, $499.50 per Person.; Braco Village Hotel & Spa – Runaway Bay, Jamaica;
;
2013-01-22;
2013-01-22;
http://api.yieldkit.com/v1/redirect?type=incentive&id=50add79cd[...]
SAMPLE RESPONSE JSON:
{
"total":100,
"page":1,
"size":10,
"incentives":[
{
"id":"50add79cda0639c6b787c63a",
"advertiser":"Groupon US",
"description":"4- or 7-Night All-Inclusive Stay for Two. Comb[...]",
"name":"Braco Village Hotel & Spa – Runaway Bay, Jamaica",
"code":"",
"validFrom":"2013-01-22",
"validTo":"2013-01-22",
"trackingLink":"http://r.srvtrck.com/v1/redirect?type=incenti[...]"
},
...
]
}