Skip to content

Players export

Exports the end users (players) attributed to your affiliates as a GZIP-compressed CSV file, one row per player, with their registration, attribution and tracking details.

Request example

curl -X POST https://affiliatecontrol-api.com/external/exports/players \
  -H "x-access-key: ak_example123" \
  -H "x-secret-key: sk_example456" \
  -H "Content-Type: application/json" \
  -d '{
    "site_id": ["site_abc"],
    "webhook_url": "https://example.com/hook"
  }'

Parameters:

  • site_id (Array of String): Limit to specific sites. Defaults to all of your sites.
  • webhook_url (String): URL notified when the file is ready.

Response:

{ "id": "export-id-here" }

Output fields

# Field Type Description
1 id string Internal player ID.
2 site_id string Site ID.
3 site_player_id string Player ID.
4 first_name string | null First Name.
5 last_name string | null Last Name.
6 email string | null Email.
7 phone_number string | null Phone number.
8 is_virtual boolean Whether the player is virtual.
9 player_country_code string | null Player country code (ISO 3166-1 alpha-2).
10 affiliate_id string Affiliate ID the player is attributed to.
11 affiliate_offer_id string Offer ID the player is attributed to.
12 created_at string (datetime) Registered (registration timestamp).
13 last_active_at string (datetime) | null Last activity timestamp.
14 btag string | null Tracking BTAG.
15 tracking_url_short_id string | null Short tracking-URL ID derived from the BTAG.
16 promo_code_id string | null Promo code applied at registration.
17 marketing_material_id string | null Marketing material the player came from.
18 external_id string | null External ID.
19 subid1 string | null SubID 1 tracking parameter.
20 subid2 string | null SubID 2 tracking parameter.
21 subid3 string | null SubID 3 tracking parameter.
22 subid4 string | null SubID 4 tracking parameter.
23 subid5 string | null SubID 5 tracking parameter.
24 subid6 string | null SubID 6 tracking parameter.
25 subid7 string | null SubID 7 tracking parameter.
26 subid8 string | null SubID 8 tracking parameter.
27 subid9 string | null SubID 9 tracking parameter.
28 subid10 string | null SubID 10 tracking parameter.
29 is_restricted_promo boolean Promo-restriction flag.
30 is_blocked boolean Whether the player is blocked.
31 date_of_birth string (date) | null Date of birth.