API Documentation

Commission Reporting API

This API allows publishers to query current and historical information pertaining to their commissions.

Changelog


0.1

2011-08-25 - Initial Version

0.2

2011-09-28 - Added reportcommissionshistory method

0.3

2012-01-31 - Searching by commissionID added.
2012-07-12 - Added pagination information to responses
2012-12-03 - Added merchant url to responses
2013-01-08 - Added reportproducts endpoint

0.4

2013-02-15 - Added product information in /reportcommissions and /reportcommissionshistory call

0.5

2013-03-05 - Ability to query on multiple products seperated by ',' for /reportdays, /reportmerchants, /reportdaysbymerchant, /reportproducts, /reportpage. Products available are skimlinks, skimwords & showcases

FAQs

API Versions

Publishers may access different versions of the API by supplying the `version` parameter

<skimlinksAccount version='0.5'>

Authentication

In order to generate the authentication token for this API, use the following method (in PHP format '.' is string concatenation, not multiplication):

Request

md5( TIMESTAMP . PRIVATE_API_KEY )

Response

md5( RESPONSE TIMESTAMP . STATUS CODE [200 etc.] . PRIVATE_API_KEY )

`TIMESTAMP` is an ISO 8601 date

API Endpoint

The Reporting API endpoint is:

https://api-reports.skimlinks.com

Please note: The Reporting API can only be used over HTTPS

API Methods

The Reporting API consists of five methods, as described below:

Report Commissions History (/publisher/reportcommissionshistory)

Every Skimlinks commission event is given a unique ID and a timestamp. This API allows the user to query events that occurred after a certain event ID or timestamp, or between two event IDs or timestamps, as well as querying for all events pertaining to commissions with particular transaction dates, domainIDs or customIDs.

Endpoint

/publisher/reportcommissionshistory
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

endEventTime

required

The event timestamp at which to end the report - ISO 8601 timestamp

startEventTime

required

The event timestamp at which to begin the report - ISO 8601 timestamp

commissionID

optional

List only a single commission with the given ID - int.

startDate

optional

The date at which to begin the commission report - YYYY-mm-dd

Minimum date - 2011-12-01

domainID

optional

List only commissions generated by a specific domain - int

endDate

optional

The date at which to end the commission report - YYYY-mm-dd

format

optional

The format of the response either xml or json. Default value is xml.

endEventID

optional

The unique event ID at which to end the report - int(11)

customID

optional

List only commissions with a specific custom ID (an ID given by the publisher to mark a commission). Known as xcust in Link API - varchar(50).

publisherID

optional

If you are a SkimBox user with a previously created API key, you may choose to report the commissions associated with one of the multiple publishers created using the SkimBox API. In this case, your publisher ID will be the first part of the Skimlinks publisher ID - int.

event

optional

Either import, update or cancel

startEventID

optional

The unique event ID at which to begin the report - int(11)

Example API Call / Response

XML
JSON

GET

Example Call

https://api-reports.skimlinks.com/publisher/reportcommissionshistory?version=0.5&timestamp=2012-03-13T12%3A19%3A01%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=7699d660f84035e9aacd8bf8a9594212&startDate=2011-12-01&endDate=2012-12-25&commissionID=5753362

XML Response

<skimlinksAccount version='0.5'>
  <timestamp>2012-03-13T12:13:06+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <commissions>
    <commission>
      <eventID>5678910</eventID>
      <eventTime>2011-12-30T11:36:12+00:00</eventTime>
      <event>cancel</event>
      <commissionID>123456</commissionID>
      <transactionDate>2011-12-13</transactionDate>
      <publisherID>123</publisherID>
      <domainID>456</domainID>
      <merchantID>9921</merchantID>
      <commissionValue>-1000</commissionValue>
      <orderValue>-10000</orderValue>
      <currency>USD</currency>
      <status>cancelled</status>
      <items>-1</items>
      <commissionType>lead</commissionType>
      <products>
        <product>
          <sku>5347926</sku>
          <quantity>1</quantity>
          <name>AEI Wireless Video/TV Sender</name>
          <unitPrice>3499.00000</unitPrice>
          <totalCommission />
        </product>
      </products>
      <clickTime>2011-12-01T07:24:25+00:00</clickTime>
      <remoteUserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64; rv:8.0) Gecko/20100101 Firefox/8.0</remoteUserAgent>
      <remoteReferer>http://yoursite.com/somesite.html</remoteReferer>
      <customID>VHVoUEtRb0JDamNBQURuMjRWd0FBQUpa</customID>
      <url>http://www.amerchant.com/product.html</url>
    </commission>
  </commissions>
  <pagination>
    <total>500</total>
    <from>0</from>
    <itemCount>100</itemCount>
  </pagination>
  <authtoken>2a2a426945d5d8bb8335bdda2eecb6fe</authtoken>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

eventID

The unique ID associated with the event. These IDs increase linearly with increasing timestamp.

status

This will be 'active' if the commission is still valid, otherwise 'cancelled'.

domainID

The domain from which the click was recorded.

transactionDate

The date on which the transaction associated with the commission was recorded (this is date in the reportcommissions API).

eventTime

The time at which the event occurred.

currency

The currency in which the above two values are returned (we make an effort to return all commissions in the publisher's own currency, but conversion data may not always be available).

remoteReferer

The page on which the click was recorded (only available for some networks).

customID

A custom ID that can be given by a publisher to each individual click (only available for some networks).

itemCount

Number of results returned by this request

event

This can be one of import, update or cancel

commissionID

A unique ID Skimlinks associates with each commission.

clickTime

The date and time when the click that resulted in the commission occurred (only available for some networks).

total

Total number of rows available in the dataset, regardless of pagination

from

Starting point for paginated results

commissionValue

The change to the total publisher commission effected by this event (in cents/pence).

orderValue

The change to the total order amount effected by this event (in cents/pence).

url

The merchant URL clicked that generated this commission (only available for some networks).

items

The number of unique items associated with this commission.

commissionType

Can be "unknown", "lead", "sale", "cpc" or "performance" if the commission is a performance incentive commission.

remoteUserAgent

The user agent through which the click was recorded (only available for some networks).

merchantID

The ID of the merchant responsible for the commission.

Report Commissions (/publisher/reportcommissions)

This method requires a beginning and ending transaction date, and returns all commissions with transaction dates between those dates.

Endpoint

/publisher/reportcommissions
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

endDate

required

The date at which to end the commission report - YYYY-mm-dd

startDate

required

The date at which to begin the commission report - YYYY-mm-dd

Minimum date - 2011-12-01

commissionID

optional

List only a single commission with the given ID - int

status

optional

When set to 'cancelled', only cancelled commissions in the time range will be returned. When set to 'active', only active commissions will be returned - varchar(50).

domainID

optional

List only commissions generated by a specific domain. To get the domainID take the second part of the Skimlinks publisherID for the domain in question. For example, if your Skimlinks publisherID for mysite.com is 13125X742327, you would use 742327 as the domainID - int.

format

optional

The format of the response either xml or json. Default value is xml.

customID

optional

List only commissions with a specific custom ID (an ID given by the publisher to mark a commission). Known as xcust in Link API - varchar(50).

publisherID

optional

If you are a SkimBox user with a previously created API key, you may choose to report the commissions associated with one of the multiple publishers created using the SkimBox API. In this case, your publisher ID will be the first part of the Skimlinks publisher ID - int.

Example API Call / Response

XML
JSON

GET

Example Call

https://api-report.skimlinks.com/publisher/reportcommissions?version=0.5&timestamp=2012-03-13T14%3A12%3A37%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=c40bf203c8b5f107636b4e545a40d324&startDate=2011-12-01&endDate=2011-12-25

XML Response

<skimlinksAccount version="0.5">
  <timestamp>2012-03-13T14:12:38+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <commissions>
    <commission>
      <commissionID>123456</commissionID>
      <date>2012-12-01</date>
      <publisherID>123</publisherID>
      <domainID>456</domainID>
      <merchantID>11135</merchantID>
      <commissionValue>1000</commissionValue>
      <orderValue>10000</orderValue>
      <currency>USD</currency>
      <status>active</status>
      <items>1</items>
      <sales>1</sales>
      <clickTime>2011-12-01T08:04:54+00:00</clickTime>
      <commissionType>sale</commissionType>
      <products>
        <product>
          <sku>5347926</sku>
          <quantity>1</quantity>
          <name>AEI Wireless Video/TV Sender</name>
          <unitPrice>3499.00000</unitPrice>
          <totalCommission />
        </product>
      </products>
      <remoteUserAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_5_8) AppleWebKit/534.50.2 (KHTML, like Gecko) Version/5.0.6 Safari/533.22.3</remoteUserAgent>
      <remoteReferer>http://yoursite.com/somesite.html</remoteReferer>
      <customID>VHI0b3Bnb0JDeGtBQUF5TmI3c0FBQU5E</customID>
      <url>http://www.amerchant.com/product.html</url>
    </commission>
  </commissions>
  <authtoken>b065656b138008529ca38a6bf01639f4</authtoken>
  <pagination>
    <total>500</total>
    <from>0</from>
    <itemCount>100</itemCount>
  </pagination>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

status

This will be 'active' if the commission is still valid, otherwise 'cancelled'.

domainID

The domain from which the click was recorded.

sales

The number of unique sales associated with this commission - legacy, as we group items and sales.

currency

The currency in which the above two values are returned (we make an effort to return all commissions in the publisher's own currency, but conversion data may not always be available).

remoteReferer

The page on which the click was recorded (only available for some networks).

date

The date on which the transaction associated with the commission was recorded.

customID

A custom ID that can be given by a publisher to each individual click (only available for some networks).

itemCount

Number of results returned by this request

publisherID

The ID of the publisher associated with the commission.

commissionID

A unique ID Skimlinks associates with each commission - use this to query commissions.

clickTime

The date and time when the click that resulted in the commission occurred (only available for some networks).

total

Total number of rows available in the dataset, regardless of pagination

from

Starting point for paginated results

commissionValue

The value of the commission (in cents/pence).

orderValue

The total value of the order (in cents/pence).

url

The merchant URL clicked that generated this commission (only available for some networks).

items

The number of unique items associated with this commission.

commissionType

Can be "unknown", "lead", "sale", "cpc" or "performance" if the commission is a performance incentive commission.

remoteUserAgent

The user agent through which the click was recorded (only available for some networks).

merchantID

The ID of the merchant responsible for the commission.

Test (/publisher/test)

This method takes the API key and auth token, and responds with success if they are correct.

Endpoint

/publisher/test
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

format

optional

The format of the response either xml or json. Default value is xml.

Example API Call / Response

XML
JSON

GET

Example Call

https://api-report.skimlinks.com/publisher/test?version=0.5&timestamp=2012-03-13T11%3A10%3A29%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=957e98a859cfd7cc1ee29086cdf3546e

XML Response

<skimlinksAccount version="0.5">
  <timestamp>2012-03-13T11:10:31+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <authtoken>d41d8cd98f00b204e9800998ecf8427e</authtoken>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

Report Days (/publisher/reportdays)

The method returns a daily summary of clicks and commissions earned by a publisher on a given day.

Endpoint

/publisher/reportdays
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

endDate

required

The date at which to end the commission report - YYYY-mm-dd

startDate

required

The date at which to begin the commission report - YYYY-mm-dd

Minimum date - 2009-01-01

product

optional

The product type you would like to narrow the results down to. Can be one of skimlinks, skimwords, showcases or all. It also accepts multiple products seperated by commas, e.g. skimlinks,skimwords. Default is all.

domainID

optional

List only commissions generated by a specific domain. To get the domainID take the second part of the Skimlinks publisherID for the domain in question. For example, if your Skimlinks publisherID for mysite.com is 123X456, you would use 456 as the domainID - int.

publisherID

optional

If you are a SkimBox user with a previously created API key, you may choose to report the commissions associated with one of the multiple publishers created using the SkimBox API. In this case, your publisher ID will be the first part of the Skimlinks publisher ID - int.

merchantID

optional

Summarizes only clicks and commissions generated by a specific merchant - int

format

optional

The format of the response either xml or json. Default value is xml.

Example API Call / Response

XML
JSON

GET

Example Call

https://api-reports.skimlinks.com/publisher/reportdays?version=0.5&timestamp=2012-03-13T12%3A40%3A56%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=0baf9886a69baa4a876c37c555513dce&startdate=2011-11-30&enddate=2011-12-01

XML Response

<skimlinksAccount version="0.5">
  <timestamp>2012-03-13T12:40:58+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <days>
    <day>
      <date>2011-11-30</date>
      <domainID>456</domainID>
      <publisherID>123</publisherID>
      <clicks>34569</clicks>
      <totalCommission>100000</totalCommission>
      <totalOrder>10000000</totalOrder>
      <currency>USD</currency>
      <items>1500</items>
    </day>
  </days>
  <pagination>
    <total>500</total>
    <from>0</from>
    <itemCount>100</itemCount>
  </pagination>
  <authtoken>14ffa0fec18924ef004ecb8ed94ec18b</authtoken>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

total

Total number of rows available in the dataset, regardless of pagination

domainID

The domain from which the clicks and commissions were recorded.

from

Starting point for paginated results

items

The number of items sold.

totalOrder

The total value of the order (in cents/pence).

currency

The currency in which the above two values are returned (we make an effort to return all commissions in the publisher's own currency, but conversion data may not always be available).

date

The date being summarized.

itemCount

Number of results returned by this request

publisherID

The ID of the publisher being reported.

clicks

The number of clicks recorded for the domain.

totalCommission

The total value of commissions earned on that day (in cents/pence).

Report Merchants (/publisher/reportmerchants)

Report a summary of clicks and commissions received per domain, per merchant.

Endpoint

/publisher/reportmerchants
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

endDate

required

The date at which to end the commission report - YYYY-mm-dd

startDate

required

The date at which to begin the commission report - YYYY-mm-dd

Minimum date - 2009-01-01

orderBy

optional

How to order the returned results. Parameter must be formatted in the following way field|direction, more fields and directions can be added using comma separation field|direction,field2|direction2. The following fields are valid clicks,totalCommission,ecpc,conversionRate,sales,merchantName and the following directions are valid ascending,descending. Note that the fields are hierarchical, therefore the result will be ordered by field first, and field2 second.

product

optional

The product type you would like to narrow the results down to. Can be one of skimlinks, skimwords, showcases or all. It also accepts multiple products seperated by commas, e.g. skimlinks,skimwords. Default is skimlinks.

domainID

optional

List only commissions generated by a specific domain. To get the domainID take the second part of the Skimlinks publisherID for the domain in question. For example, if your Skimlinks publisherID for mysite.com is 123X456, you would use 456 as the domainID - int.

merchantName

optional

Summarizes only clicks and commissions generated by merchant's whose name matches the given parameter- string

format

optional

The format of the response either xml or json. Default value is xml.

responseFrom

optional

What row to begin returning results from (default 0) - int

responseLimit

optional

How many results to return (maximum 100) (default 100) - int

publisherID

optional

If you are a SkimBox user with a previously created API key, you may choose to report the commissions associated with one of the multiple publishers created using the SkimBox API. In this case, your publisher ID will be the first part of the Skimlinks publisher ID - int.

merchantID

optional

Summarizes only clicks and commissions generated by a specific merchant - int

Example API Call / Response

XML
JSON

GET

Example Call

https://api-reports.skimlinks.com/publisher/reportmerchants?version=0.5&timestamp=2012-03-13T13%3A17%3A12%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=f9756b755eff5de2e1b2c0f6bb60c4e7&startdate=2011-11-30&enddate=2011-12-01

XML Response

<skimlinksAccount version="0.5">
  <timestamp>2012-03-13T16:14:33+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <merchants>
    <merchant>
      <merchantID>12678</merchantID>
      <merchantName>Amazon US</merchantName>
      <clicks>999</clicks>
      <totalCommission>100000</totalCommission>
      <ecpc>63</ecpc>
      <conversionRate>0.1234</conversionRate>
      <currency>USD</currency>
    </merchant>
  </merchants>
  <authtoken>c24f8cf751fbf2536761a57806ed7573</authtoken>
  <pagination>
    <total>500</total>
    <from>0</from>
    <itemCount>100</itemCount>
  </pagination>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

itemCount

Number of results returned by this request

from

Starting point for paginated results

merchantName

The name of the merchant

sales

The number of sales made for this period.

conversionRate

The number of sales divided by the number of clicks, the value is returned as a decimal representation of the percentage. For example, a 12.34% conversionRate will be returned as 0.1234

currency

The currency in which the above two values are returned (we make an effort to return all commissions in the publisher's own currency, but conversion data may not always be available)

ecpc

The estimated cost per click for the merchant

total

Total number of rows available in the dataset, regardless of pagination

clicks

The number of clicks recorded for the merchant

totalCommission

The total value of commissions earned by the merchant (in cents/pence)

Report Products (/publisher/reportproducts)

Deprecated - Support for this method will be discountinued in the near future.

This endpoint provides a summary of the products that were purchased by a publisher's visitors, where this information is known. The response can be filtered by publisher site, merchant, and type of Skimlinks product, ie SkimLinks or SkimWords.

Endpoint

/publisher/reportproducts
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

startDate

optional

Limit the response to data starting at this date - YYYY-mm-dd

product

optional

The product type you would like to narrow the results down to. Can be one of skimlinks, skimwords, showcases or all. It also accepts multiple products seperated by commas, e.g. skimlinks,skimwords. Default is all.

domainID

optional

Filters response by a specific site on your Skimlinks account. To get the domainID take the second part of the Skimlinks publisherID for the domain in question. For example, if your Skimlinks publisherID for mysite.com is 123X456, you would use 456 as the domainID - int. You can find your publisherID in the Manage Sites section of the Publisher Interface under Publisher ID.

endDate

optional

Limit the response to data ending at this date - YYYY-mm-dd

format

optional

The format of the response either xml or json. Default value is xml.

responseFrom

optional

What row to begin returning results from (default 0) - int

responseLimit

optional

How many results to return (maximum 200) (default 200) - int

merchantID

optional

Filters a response by a specific merchant - int

Example API Call / Response

XML
JSON

GET

Example Call

https://api-reports.skimlinks.com/publisher/reportproducts?version=0.5&timestamp=2012-03-13T13%3A17%3A12%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=f9756b755eff5de2e1b2c0f6bb60c4e7&startdate=2013-01-01&enddate=2013-12-02

XML Response

<skimlinksAccount version="0.5">
  <timestamp>2013-03-13T13:17:13+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <products>
     <product1>
         <id>78348</id>
         <date>2013-01-14</date>
         <domainID>1</domainID>
         <publisherID>1</publisherID>
         <SKU>B0027UY8B8</SKU>
         <commissionValue>408.671475</commissionValue>
         <unitPrice>6061.7581</unitPrice>
         <quantity>1</quantity>
         <currency>GBP</currency>
         <merchantID>124567</merchantID>
         <commissionID/>
         <name>Your Product</name>
     </product1>
  </products>
  <pagination>
    <total>500</total>
    <from>0</from>
    <itemCount>100</itemCount>
  </pagination>
  <authtoken>16fbf502d14d73af409e9a7dbcc1d4dd</authtoken>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

commissionID

Skimlinks associates a unique ID with each commission. If the returned product can be associated with a specific commission, this field will be populated. This field will return null for networks or merchants that do not provide this associative information.

SKU

The SKU of the purchased product.

domainID

The ID of the site on which the original click that drove the product purchased was made.

from

Starting point for paginated results

name

Product name as assigned by network

publisherID

The ID of the publisher being reported.

commissionValue

The total value commission earned for this product

currency

The currency in which the totalCommission and unitPrice fields are reported in

date

Transaction date when product was purchased

total

Total number of rows available in the dataset, regardless of pagination

itemCount

Number of rows returned by this request

unitPrice

The list price of the purchased product, converted to the publisher’s reporting currency

merchantID

The ID of the merchant from which the product was purchased

quantity

The amount of products purchased

Report Page (/publisher/reportpage)

Deprecated - Support for this method will be discountinued in the near future.

A summary of clicks and commissions per page

Endpoint

/publisher/reportpage
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

endDate

required

The date at which to end the page report - YYYY-mm-dd

startDate

required

The date at which to begin the page report - YYYY-mm-dd

Minimum date - 2011-12-01

product

optional

The product type you would like to narrow the results down to. Can be one of skimlinks, skimwords, showcases or all. It also accepts multiple products seperated by commas, e.g. skimlinks,skimwords. Default is all.

domainID

optional

Filters response by a specific domain. To get the domainID take the second part of the Skimlinks publisherID for the domain in question. For example, if your Skimlinks publisherID for mysite.com is 123X456, you would use 456 as the domainID - int.

merchantID

optional

Filters a response by a specific merchant - int

format

optional

The format of the response either xml or json. Default value is xml.

Example API Call / Response

XML
JSON

GET

Example Call

https://api-reports.skimlinks.com/publisher/reportpage?version=0.5&timestamp=2012-03-13T13%3A17%3A12%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=f9756b755eff5de2e1b2c0f6bb60c4e7&startdate=2011-12-01&enddate=2011-12-02

XML Response

<skimlinksAccount version="0.5">
  <timestamp>2012-03-13T13:17:13+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <pages>
    <page1>
      <url>http://yourdomain.com/</url>
      <urlHash>f934d50d42be6d51df12a36b7db80313</urlHash>
      <clicks>13082</clicks>
      <totalCommission>218721</totalCommission>
      <currency>USD</currency>
    </page1>
  </pages>
  <pagination>
    <total>500</total>
    <from>0</from>
    <itemCount>100</itemCount>
  </pagination>
  <totals>
    <totalCommission>685476.25414</totalCommission>
    <ecpc>20.910141362</ecpc>
    <clicks>32782</clicks>
  </totals>
  <authtoken>16fbf502d14d73af409e9a7dbcc1d4dd</authtoken>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

url

The url of the page.

urlHash

Unique hash of the page URL.

clicks

The number of clicks recorded for the page.

totalCommission

The total value of commissions earned on that day (in cents/pence).

currency

The currency in which the above two values are returned (we make an effort to return all commissions in the publisher's own currency, but conversion data may not always be available).

Report Days by Merchant (/publisher/reportdaysbymerchant)

Report a summary of clicks and commissions received per domain, per day, per merchant.

Endpoint

/publisher/reportdaysbymerchant
Fields Description
authtoken

required

MD5 of timestamp and private API key - varchar(50)

timestamp

required

ISO 8601 timestamp

apikey

required

Public API key - char(32)

endDate

required

The date at which to end the commission report - YYYY-mm-dd

startDate

required

The date at which to begin the commission report - YYYY-mm-dd

Minimum date - 2009-01-01

product

optional

The product type you would like to narrow the results down to. Can be one of skimlinks, skimwords, showcases or all. It also accepts multiple products seperated by commas, e.g. skimlinks,skimwords. Default is skimlinks.

domainID

optional

List only commissions generated by a specific domain. To get the domainID take the second part of the Skimlinks publisherID for the domain in question. For example, if your Skimlinks publisherID for mysite.com is 123X456, you would use 456 as the domainID - int.

publisherID

optional

If you are a SkimBox user with a previously created API key, you may choose to report the commissions associated with one of the multiple publishers created using the SkimBox API. In this case, your publisher ID will be the first part of the Skimlinks publisher ID - int.

merchantID

optional

Summarizes only clicks and commissions generated by a specific merchant - int

format

optional

The format of the response either xml or json. Default value is xml.

Example API Call / Response

XML
JSON

GET

Example Call

https://api-reports.skimlinks.com/publisher/reportdaysbymerchant?version=0.5&timestamp=2012-03-13T13%3A17%3A12%2B00%3A00&apikey=aabbccddeeffgghhiijjkk1122334455&authtoken=f9756b755eff5de2e1b2c0f6bb60c4e7&startdate=2011-11-30&enddate=2011-12-01

XML Response

<skimlinksAccount version="0.5">
  <timestamp>2012-03-13T13:17:13+00:00</timestamp>
  <apikey>aabbccddeeffgghhiijjkk1122334455</apikey>
  <result>200</result>
  <days>
    <day merchantID="12515">
      <date>2011-12-01</date>
      <publisherID>123</publisherID>
      <merchantID>12515</merchantID>
      <domainID>456</domainID>
      <clicks>1</clicks>
      <totalCommission>0</totalCommission>
      <totalOrder>0</totalOrder>
      <currency>USD</currency>
      <items>0</items>
    </day>
  </days>
  <pagination>
    <total>500</total>
    <from>0</from>
    <itemCount>100</itemCount>
  </pagination>
  <authtoken>16fbf502d14d73af409e9a7dbcc1d4dd</authtoken>
</skimlinksAccount>

              

Responses

This method returns the following fields:

Fields Description
authtoken

MD5 of timestamp and private API key - varchar(50)

status

The API returns a result tag. Status value 200 indicates everything went smoothly.

apikey

Public API key - char(32)

timestamp

ISO 8601 timestamp

total

Total number of rows available in the dataset, regardless of pagination

domainID

The domain from which the clicks and commissions were recorded.

from

Starting point for paginated results

items

The number of items sold.

publisherID

The ID of the publisher being reported.

merchantID

The merchant for which the clicks and commissions were recorded.

currency

The currency in which the above two values are returned (we make an effort to return all commissions in the publisher's own currency, but conversion data may not always be available).

date

The date being summarized.

itemCount

Number of results returned by this request

totalOrder

The total value of the order (in cents/pence).

clicks

The number of clicks recorded for the domain.

totalCommission

The total value of commissions earned on that day (in cents/pence).