ChannelMix API connection is built around the Skai API.
Connection Guide
Currently Supported Version: | V2 report based API, V1.0.0 configurable API |
---|---|
Attribution Window: | N/A |
Time Zone Reporting: | N/A |
API Limitations: |
|
Backfill Limitations: |
Standard source activation allows for up to 500 days of backfill (see Dataset Activation). |
Refresh Limit: | None |
Connection Authentication
There are two versions of the Skai API that ChannelMix interfaces with, one the that is report based and one that is configurable.
When connecting to Skai regardless of the API version being used, be prepared to provide the username and password of the account you wish ChannelMix to use as well as the Kenshoo ID*. If using the report API the report ID is needed as well
Report Based Connection
As the names suggest, the report based API requests data using a report ID that is created in the platform by the user and returns data based on that report. Any changes to the data—be that adding or removing fields—must first be done in the report before ChannelMix can update the database.
Configurable Based Connection
The Configurable API allows for a bit more flexibility and allows ChannelMix to update datasets without needing the client to make the necessary changes first.
- We recommend naming the connection in a way the displays the Kenshoo ID
- The Kenshoo ID* can be found in the subdomain of the user's dashboard. If the dashboard URL is "ks5146.kenshoo.com" then the Kenshoo ID is ks5415
- If using the report API, please provide the report ID in the Notes section
*Skai was originally called Kenshoo. Client facing documentation and branding have been changed to Saki, however developer documentation and user dashboards still use Kenshoo domains
Data Guide
Lag Time: | 1 day |
---|---|
Span: | 30 |
ChannelMix automates data from Skai that is available from the report set up in the UI. In order to automate the data in the ChannelMix you will need to set up at least one report in the platform and provide the ID
Report Type | API Source Documentation | ChannelMix Datasets |
---|---|---|
Client Created Report | N/A |
N/A |
Campaign | N/A | |
Ad Groups | N/A | |
Ads | N/A |