Internal APIs

This API is used for server-to-server communication between your product and AffiliateControl.
You can find a description of our internal API here:

Environments

Test environment

• Documentation (Swagger UI)
• OpenAPI 3.0 JSON

Production environment

• Documentation (Swagger UI)
• OpenAPI 3.0 JSON

Endpoints

Exports

You can request a data dump for the following five types of entities: Reports, Players, Affiliates, Payments, and Offers.

Please note that any data dump export is an asynchronous process. When you request an export, you will receive an export ID.

You can use this ID to periodically check the export status via the Misc API endpoint (GET /misc/exports/{id}).

Alternatively, you can specify the webhook_url request parameter. When the file is ready, a POST request will be made to the specified URL with a JSON body containing the export ID and download URL ({“exportId”: “export-id-here”, “downloadUrl”: “url-to-data-dump-file”, “status”: ‘success’ | “error”}).

The dump file is a GZIP-compressed CSV file.

We restrict the number of requests to create dumps to no more than five per hour and no more than ten per 24 hours for each type. Contact us if you need to increase the limit.