Breadcrumbs

Merchant statistics - Resources

mportant Note: When requesting data for the previous day, it is possible that the data compilation process is not complete yet. In that case, please retry later to obtain the requested data.

The base URL is: https://api.kelkoogroup.net/merchant/statistics/v1

All resources must be authenticated using a JSON Web Token (JWT). See JWT Guide

Resources

/my-campaigns

This resource will return a list of campaign containing an id (internal identifier of a campaign), a name, a country and a website url

JSON
[{
  "campaignId": 1000000000,
  "campaignName": "Example.fr",
  "websiteUrl": "http://www.example.fr",
  "country": "fr"
}, {
  "campaignId": 1000000001,
  "campaignName": "Sample.co.uk",
  "websiteUrl": "http://www.sample.co.uk",
  "country": "uk"
}]

/category/{campaignId}?startDate={startDate}&endDate={endDate}

This resource will return the clicks registered at this campaign id in the range (startDate to endDate both included).

The values will be formatted as following: (this is an example)

JSON
[
  {
    "campaignId": 1000000000,
    "date": "2021-03-15",
    "catId": 100305123,
    "catName": "Games",
    "deviceType": "Mobile",
    "currency": "EUR",
    "clicks": 7,
    "cost": 1.3566,
    "sales": 2,
    "orderValue": 58.91,
    "trackedLeads": 7,
    "costTrackedLeads": 1.3566
  }
]

An object is grouping all clicks made for one day (date), one category (catId with the name catName) and one device (deviceType)

Fields sales, orderValue, trackedLeads and costTrackedLeads will only be filled if Kelkoo Sales Tracking is activated.

/product/{campaignId}?startDate={startDate}&endDate={endDate}

This resource will return the clicks registered at this campaign id in the range (startDate to endDate both included).

The values will be formatted as following: (this is an example)

JSON
[
  {
    "campaignId": 1000000000,
    "date": "2021-03-15",
    "catId": 100305123,
    "catName": "Games",
    "deviceType": "Mobile",
    "currency": "EUR",
    "clicks": 7,
    "cost": 1.3566,
    "sales": 2,
    "orderValue": 58.91,
    "trackedLeads": 7,
    "costTrackedLeads": 1.3566,
    "offerTitle": "Playing cards",
    "productUrl": "http://my-site.com/playing-cards.html",
    "offerOnSale": 0
  }
]

An object is grouping all clicks made for one day (date), one category (catId with the name catName) and one device (deviceType) on one product

Fields sales, orderValue, trackedLeads and costTrackedLeads will only be filled if Kelkoo Sales Tracking is activated.

/sales/{campaignId}?startDate={startDate}&endDate={endDate}

This resource will return the sales registered at this campaign id in the range (startDate to endDate both included).

The values will be formatted as following: (this is an example)

JSON
[
  {
    "campaignId": 1000000000,
    "orderId": "1",
    "leadId": "dc1.kelkoo.net_1657737217631_6186757",
    "categoryId": 137701,
    "localCurrency": "EUR",
    "productUrl": "https://track.io/siteid-471007",
    "offerTitle": "iPhone X",
    "deviceType": "Computer",
    "localOrderValue": 0,
    "saleIsClosed": false,
    "saleDate": "2022-06-22 10:10:22",
    "lastRecordDate": "2022-06-24",
    "leadDate": "2022-06-02 10:10:22",
    "sessionDuration":1728000000,
    "orderBasket": [
      {
        "name": "Longue robe",
        "price": 19.9,
        "quantity": 1,
        "sku": "1518007"
      }
    ]    
  }
]

Only 2 years of data can be retrieved from today.