Partner data export file
Creating the URL
The URL required for creating a partner data export file is build up as following:
https://export.net.[domain]/[your_api_key]/adm-affiliateexport_[user_ID].[file_extension]?[filters]
Once you have filled in the export domain, the API key, your user ID and the relevant file extension and you have applied filters, your URL should look more or less like this:
https://export.net.yourdomain.com/f0d58188-5420-1234-8485-0417a3a85886/adm-affiliateexport_123.csv?filter[a:advertiser_program_id]=456&filter[from_date]=01.06.2014&filter[to_date]=27.08.2014
Applying filters
For the partner data export file, following filters can be applied:
Filter description | Filter name | Compulsory | Format |
---|---|---|---|
Allows you to filter partners by registration date, from the date you fill in. | from_date | No |
|
Allows you to filter partners by registration date, until the date you fill in. | to_date | No |
|
Allows you to filter partners by advertiser program. | a: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 | Example |
---|---|---|
uid | The user ID of the partner. | 123 |
The email of the partner. | ||
first_name | The first name of the partner. | Joe |
last_name | The last name of the partner. | Fischer |
address | The address of the partner. | New Street 4 |
zipcode | The zip code of the partner. | 12345 |
city | The city in which the partner is registered. | London |
countrycode | The code of the country in which the partner is registered according to ISO 3 and 2, divided by underscore. | DEU_DE |
currencycode | The code of the currency of the country in which the partner is registered, according to ISO standards. | EUR |
phone | The phone number of the partner (optional) | 555-4985 5467 |
language | The language in which the partner uses the partner account. | ENG |
status | The status of the partner: 0 = waiting for confirmation, 1 = active, 2 = deactivated, -1 = deleted. | 1 |
user_vat | Whether the partner is obliged to pay value added tax. | TRUE |
company | The registered name of the company of the partner. | Max Profit Inc. |
registration_date | The time and date of the moment the partner registered for the platform in the following format: yyyy-mm-dd hh:mm:ss+miliseconds. | 2014-04-10 12:07:25+02 |
payout_limit | The height of the payout limit. NB: 0 implies the partner did not set a limit. | 0 |
newslettersettings | Whether the partner receives platform newsletters and notifications via email and the account inbox or only via the account inbox. | inbox |
entity_id | The ID of the entity to which the partner has been allocated. | 82 |
last_modification | The time and date of the moment the partner last modified data in the following format: yyyy-mm-dd hh:mm:ss+miliseconds. | 2018-01-29 17:05:35.404182+01 |
platform_id | The ID of the platform to which the partner is allocated. | 40 |
thirdpt_tracking_settings | Whether the partner has implemented third party tracking settings. | TRUE |
transfer_type | The method applied to transfer commission: sepa, iban or bank account. | 1 |
labels | The labels used to categorize the partners. | high traffic |
email_confirmed | Whether the partner has verified the registered email address. | TRUE |
registration_emailkey | The key used to verify the email address. | 3a20dc26-4923-467c-aa08-90e941bcf6b3 |
registration_origin | The ID of the advertiser via which the partner originally registered. | aid:3138 |
last_password_change | The time and date of the moment the partner changed the account password for the last time, in the following format: yyyy-mm-dd hh:mm:ss+miliseconds. | 2016-06-22 12:08:57.543973+02 |
login_attempts | The number of failed login attempts. | 0 |
sepa_accountholder | The name of the holder of the partner's bank account. | Joe Fischer |
sepa_iban | The IBAN of the partner's bank account. | DE00060300800200055200 |
sepa_bic | The BIC of the partner's bank account. | CDDBDE70 |
billing_countrycode | The ISO 3 and 2 country code of the country in which the bank account is registered, separated by underscore. | DEU_DE |
tax_id | The partner's tax ID. | 01/234/567895 |
vat_id | The partner's vat ID. | DE12345678992266 |
companytype | Whether the account is run by a company ('un'), a private person ('private') or is self-employed ('self', Spain only). | un |
block_payments | Whether the partner has been blocked for payment. If the partner is blocked, no payment notes can be created for the partner. 0 = not blocked, 1 = blocked. | 0 |
billingdata_confirmed | Whether the partner has verified the billing data. | 1 |
taxoffice | The tax office responsible for the partner (optional). | London 34 |
billingdata_validated | Whether the billing data of the partner could validated by the platform. | 1 |
bank |
|
|
brazil_municipalregister | A local registration ID, only relevant for partners whose business is located in Brazil. | 123456 |
brazil_stateregister | A national registration ID, only relevant for partners whose business is located in Brazil. | 123456 |
southafrica_branch | The tax branch in which the partner is active, only relevant for South Africa. | 1234 |
external_reference | An ID or code related to an external billing system, such as DATEV. (Optional) | DATEV4711 |
last_login | The time and date of the moment the partner logged in for the last time, in the following format: yyyy-mm-dd hh:mm:ss+miliseconds. | 04/08/2017 11:55 |
login_status | The current login status of the partner: 0 = not logged in, 1 = logged in. | 0 |
last_mkey_login | The time and date of the moment the partner logged in for the last time via API key, in the following format: dd/mm/yyyy hh:mm | 30/11/2017 14:22 |
entity_name | The name of the entity to which the partner is allocated. | Ingenious Technologies AG |
pids | The ID or IDs of the ad spaces the partner registered. | 1234, 1235, 1236 |
urls | The urls of the ad spaces the partner registered. | http://www.example1.com, http://www.example2.com, http://www.example3.com |