You can use the Report XML Feed to get the data for your commissions, campaign or trackers. You can customize the data that you request using the details below.
Commission Report
Request URL structure
This request contains:
- Base url https://www.entainpartners.com/members/commissionStatsFeed.do
- Authentication parameters
| Parameter | Description | Required |
|---|---|---|
| api_key | Your unique access key | Yes |
| api_secret | Your secret (used for authentication along with api_key) | Yes |
- Security
To ensure privacy you must use HTTPS for all requests
You must not share this url with unauthorized partners - Query string parameters
The following table shows the parameters you use in the request
| Parameter | Description | Required | Allowed values |
|---|---|---|---|
| groupByOption | Option to display data by brand or commission plan | Yes |
BR - By brand CP - By commission plan |
| month | Month of the year that you want data for | Yes | 0 - 11 (Jan to Dec) |
| year | Calendar year in four digit format that you want data for | Yes | Four digit |
| adChannel | The channel the ad is being promoted on - desktop or mobile or both | Yes |
0 All 1 (Desktop) 2 (Mobile) |
Response:
A Commissions Report XML Feed response returns the following keys and values
| Key | Value |
|---|---|
| CommissionStats | Total commission values aggregated across brands or commission plan |
| Stats | Brand and product wise commission values |
| Error | Error message generated |
Error tags and their meaning:
| Message | Description |
|---|---|
| No api_key/api_secret entered | Authentication has failed as no value was sent in api_key or api_secret parameter |
| Authentication failed | Authentication has failed due to incorrect value being sent in api_key or api_secret parameter |
| No groupBy option entered | No value was sent for groupBy parameter. You need to use BR or CP |
| Invalid groupBy option | The value passed for groupBy parameter is incorrect. You need to use BR or CP |
| Invalid month | The value passed for month parameter is incorrect. You need to use any value from 0-11 |
| Invalid year | The value passed for year parameter is incorrect. You need to use a four digit format for the year |
| Invalid ad channel | The value passed for adchannel parameter is incorrect. You need to use 0 - 2 |
| Technical error | Our service is unavailable due to maintenance. Please contact support@entainpartners.com or your account manager. |
Campaign Report
Request URL structure
This request contains:
- Base url https://www.entainpartners.com/members/campaignStatsFeed.do
- Authentication parameters
| Parameter | Description | Required |
|---|---|---|
| api_key | Your unique access key | Yes |
| api_secret | Your secret (used for authentication along with api_key) | Yes |
- Security
To ensure privacy you must use HTTPS for all requests
You must not share this url with unauthorized partners - Query string parameters
The following table shows the parameters you use in the request
| Parameter | Description | Required | Allowed values |
|---|---|---|---|
| groupByOption | Option to display data by campaign, date or month | Yes |
C - By campaign D - By date M - By month |
| startDate | Start date of the duration for which you need data | Yes | MM/DD/YYYY format |
| endDate | End date of the duration for which you need data | Yes | MM/DD/YYYY format |
| adChannel | The channel the ad is being promoted on - desktop or mobile or both | Yes |
0 All 1 (Desktop) 2 (Mobile) |
Response:
A Campaign Report XML Feed response returns the following keys and values
| Key | Value |
|---|---|
| CampaignStats | Total campaign values aggregated across campaign, date or month |
| Stats | Campaign wise values |
| Error | Error message generated |
Error tags and their meaning:
| Message | Description |
|---|---|
| No api_key/api_secret entered | Authentication has failed as no value was sent in api_key or api_secret parameter |
| Authentication failed | Authentication has failed due to incorrect value being sent in api_key or api_secret parameter |
| No groupBy option entered | No value was sent for groupBy parameter. You need to use BR or CP |
| Invalid groupBy option | The value passed for groupBy parameter is incorrect. You need to use C or D or M |
| No start/end date entered | No value was sent for start date or end date parameter. You need to use any value in MM/DD/YYYY format |
| Invalid start/end date | The value passed for start date or end date parameter is incorrect. You need to use any value in MM/DD/YYYY format |
| Invalid ad channel | The value passed for adchannel parameter is incorrect. You need to use 0 - 2 |
| Technical error | Our service is unavailable due to maintenance. Please contact support@entainpartners.com or your account manager. |
Tracker Report
Request URL structure
This request contains:
- Base url https://www.entainpartners.com/members/trackerStatsFeed.do
- Authentication parameters
| Parameter | Description | Required |
|---|---|---|
| api_key | Your unique access key | Yes |
| api_secret | Your secret (used for authentication along with api_key) | Yes |
- Security
To ensure privacy you must use HTTPS for all requests
You must not share this url with unauthorized partners - Query string parameters
The following table shows the parameters you use in the request
| Parameter | Description | Required | Allowed values |
|---|---|---|---|
| groupByOption | Option to display data by tracker, date or month | Yes |
T - By tracker D - By date M - By month |
| startDate | Start date of the duration for which you need data | Yes | MM/DD/YYYY format |
| endDate | End date of the duration for which you need data | Yes | MM/DD/YYYY format |
| zoneOption1 | Performing trackers | No | 1 (Performing) |
| zoneOption2 | Promoting trackers | No | 2 (Performing) |
| zoneOption3 | No activity trackers | No | 3 ( No activity) |
| zoneOption4 | Inactive trackers | No | 4 (Inactive) |
| adChannel | The channel the ad is being promoted on - desktop or mobile or both | Yes |
0 All 1 (Desktop) 2 (Mobile) |
Response:
A Tracker Report XML Feed response returns the following keys and values
| Key | Value |
|---|---|
| TrackerStats | Total values aggregated across all trackers |
| TrackerData | Values aggregated by tracker |
| Tracker | Values for the particular tracker |
| Error | Error message generated |
Error tags and their meaning:
| Message | Description |
|---|---|
| No api_key/api_secret entered | Authentication has failed as no value was sent in api_key or api_secret parameter |
| Authentication failed | Authentication has failed due to incorrect value being sent in api_key or api_secret parameter |
| No groupBy option entered | No value was sent for groupBy parameter. You need to use BR or CP |
| Invalid groupBy option | The value passed for groupBy parameter is incorrect. You need to use BR or CP |
| No start/end date entered | No value was sent for start date or end date parameter. You need to use any value in MM/DD/YYYY format |
| Invalid start/end date | The value passed for start date or end date parameter is incorrect. You need to use any value in MM/DD/YYYY format |
| Invalid tracker type | The value passed in zoneOption1 or zoneOption2 or zoneOption3 or zoneOption4 is invalid. You need to use 1,2,3 and 4 |
| Invalid ad channel | The value passed for adchannel parameter is incorrect. You need to use 0 - 2 |
| Technical error | Our service is unavailable due to maintenance. Please contact support@entainpartners.com or your account manager. |
Player Report
Request URL structure
This request contains:
- Base url https://www.entainpartners.com/members/playerRerportFeed.do
- Authentication parameters
| Parameter | Description | Required |
|---|---|---|
| api_key | Your unique access key | Yes |
| api_secret | Your secret (used for authentication along with api_key) | Yes |
- Security
To ensure privacy you must use HTTPS for all requests
You must not share this url with unauthorized partners - Query string parameters
The following table shows the parameters you use in the request
| Parameter | Description | Required | Allowed values |
|---|---|---|---|
| startDate | Start date of the duration for which you need data | Yes | MM/DD/YYYY format |
| endDate | End date of the duration for which you need data | Yes | MM/DD/YYYY format |
| playerStatus | The status of the players that you want | Yes |
Registration FTD RMP |
Response:
A Player Report XML Feed response returns the following keys and values
| Key | Value |
|---|---|
| PlayerDetails | All player values including registration information and dynamic variables |
| Error | Error message generated |
Error tags and their meaning:
| Message | Description |
|---|---|
| No api_key/api_secret entered | Authentication has failed as no value was sent in api_key or api_secret parameter |
| Authentication failed | Authentication has failed due to incorrect value being sent in api_key or api_secret parameter |
| No start/end date entered | No value was sent for start date or end date parameter. You need to use any value in MM/DD/YYYY format |
| Invalid start/end date | The value passed for start date or end date parameter is incorrect. You need to use any value in MM/DD/YYYY format |
| Invalid Player Status | The value passed for player status is incorrect. You need to use Registration or FTD or RMP |
| Technical error | Our service is unavailable due to maintenance. Please contact support@entainpartners.com or your account manager. |
