Commission model export file
Creating the URL
The URL required for creating a commission model export file is build up as following:
https://export.net.[domain]/[your_api_key]/adm-comm-model_[user_ID].[file_extension]?[filters]Once you have filled in your export domain, your API key, your user ID and the relevant file extension and you have applied your filters, your URL should look more or less like this:
https://export.net.yourdomain.com/f0d89188-5420-4ac3-84b2-0417a3a85f89/adm-comm-model_123.csv?filter[mid]=456By default your system-generated default API key is used in the export links.
Applying filters
For the commission model export file, following filters can be applied:
Filter description | Filter name | Compulsory | Format |
|---|---|---|---|
Allows you to filter by advertiser. | advertiser_program_id | No | MID, found in the advertiser center. |
These filters are to be added to the URL as parameters. Use the the question mark (?) for the first parameter and the ampersand (&) for all further parameters. Add the word filter, the filter name, the equals sign (=) and the relevant values according to the format mentioned in the table.
Output
The file you export via the URL you’ve created will contain the following data:
Name | Explanation |
|---|---|
advertiser_id | The ID of the advertiser for which the commission model was created. |
advertiser_title | The name of the advertiser for which the commission model was created. |
id | The ID of the commission model. |
name | The name of the commission model. |
description | The description of the commission model. |
status | The status of the commission model (active, deactivated or deleted). |
from | Date on which the current period became valid. |
to | Date on which the current period will expire. If the field is empty, the period is unlimited. |
period_comm_type | The type of the commission model, as defined in the current period. Values can be CPM (cost per thousand views), CPC (cost per click), PC (post click) or PV (post view). |
period_comm_conversion_target | The conversion target to which the commission model applies, as defined in the current period. |
period_comm_product_category | The product category to which the commission model applies, as defined in the current period. |
period_comm_product_category_alias | The alias of the product category mentioned in the previous column. The alias is the name via which the product category is identified in the tracking engine. |
period_comm_fix_amount | The fixed amount of commission assigned to a partner, as defined in the current period. |
period_comm_percentage_amount | The percentage of the order value assigned as commission to a partner, as defined in the current period. |
period_comm_max_amount | The maximum amount of commission that can be assigned to a partner, as defined in the current period. |
period_comm_expiration | The number of days, weeks or months after which transactions will be confirmed automatically. If the value is empty, transactions will never be confirmed automatically. |
maturity_type | The time unit of the automated confirmation: days, weeks and months. |