\n\nThis document will guide you through the integration of both the BI & Affiliate Platform of iGsuite. These are the parties we have identified to take part in this process:
\n
The Operator: This is the Client who will use the software to manage their Brands
\nThe iGaming Platform: This is the Platform under which the Operator Brand is built
\niGsuite: Us, who manage the Software of the Affiliate Platform and BI
\niGsuite combines two products in one - Affiliate Platform and BI:
\nAffiliate Platform - built for the iGaming industry. Its purpose is to enable Affiliate Marketing for the operators allowing them to build, manage and scale their partners to ensure sustainable growth. The software itself provides the following key functionality:
\nRegistration and management of affiliates
\nAllow Affiliates to access all sorts of creatives
\nTracking affiliate customers
\nCollecting and visualising data about customers
\nCalculates affiliates' profit based on customer activities
\nMonitor and manage affiliate portfolio and payments
\nNewton - the BI, tailored for the iGaming industry is the only BI built to support end to end the customer journey, cost and P&L of the company. Its main purpose is to:
\nAutomate all reports
\nProvide ready Analysis and insights of the business
\nUpdate all data in real-time
\nBelow you will find described the exact order of actions that should take place in order to get iGsuite products live for you as fast as possible.
\niGsuite should initiate the integration with the relevant parties
\nThe Operator has to provide iGsuite with their specifications towards the Affiliate Platform setup.
\nThe iGaming Platform should start to collect and return iGsuite tokens.
\nThe iGaming Platform should complete the File Integration:
\nRegistration File
\nActivity File
\niGsuite will handle full test on the Affiliate Platform end to end.
\nThe Operator should state the launch date.
\nIn order to configure iGsuite, the Operator should provide some key preferences for the platform, a questionnaire will be provided to the client later on.
\nIn this section, we also explain the necessary server configuration to have the platform under the Operator's domain.
\nNote! Everything under point 3, is a blocker for the next steps of the integration process!
\nThe Operator should provide the following in the Integration Ticket:
\nBranding:
\nAffiliate Platform Official name
\nDomain name under which you will operate the Affiliate Platform
\nLogo
\nPlatform Preferences & Access:
\nTimezone
\nCurrency
\nType of integration: (API/SFTP)
\nData transfer option: (Json, CSV, etc)
\nFrequency: (1h, 6h, 24h, etc)
\nEmail under which to sign the initial Admin Account
\nEmail under which to sign the data Integration Account
\nEmail used for our system mailers (Password reset, Confirm Account Registration, Affiliate Account approval, etc.)
\nThe Operator should provide the domain under which they would like the platform to be made available. Our integration team will provide the Operator with the necessary details so they can configure the DNS record on their domain provider.
\nEvery request to a /workspaces/api/... endpoint must include the bearer token in the Authorization header:
Authorization: Bearer YOUR_TOKEN
There are two ways to obtain a token.
\nThis produces a long-lived api token that does not expire and does not interfere with anyone's active app session. It is the right choice for production integrations.
\nStep by step:
\nOpen the report-book web application in your browser and log in as the integration account (the email you provided as the Data Integration Account in section 3.1).
\nIf 2-Factor Authentication is enabled on this account, complete the 2FA challenge.
\nFrom the main navigation, open Tools.
\nOpen the Api Tokens tab.
\nClick the Generate button. A modal will appear with the plaintext token.
\nCopy the token immediately and store it somewhere safe (e.g. your secrets manager). The token is shown only once β there is no way to retrieve it again later.
\nClose the modal. The Api Tokens tab will now show an Active state with the creation date.
\nSend the token as the value of the Authorization header (formatted as Bearer YOUR_TOKEN) on any/workspaces/api/... request. That's it β you're authenticated.
No expiration. Valid until you explicitly revoke or re-generate it.
\nSurvives deploys. Restarts and deploys of the platform do not invalidate it.
\nIndependent of UI sessions. Logging in or out of the app does not affect the token, and creating the token does not log anyone out.
\nActs as the user. Requests authenticated with this token carry the integration account's full permissions β treat the token like a password.
\nOne active api token per user at a time. Re-generating creates a new one and invalidates the old one.
\nRevocable anytime via the same Tools β Api Tokens screen, or programmatically via the Revoke Api Token request in the AUTH folder.
We strongly recommend rotating the token periodically to limit blast radius in the event of a leak.
\n\n\nNot recommended for production integrations. Use 4.1 unless you have a specific reason not to.
\n
Partners can also authenticate by calling POST /workspaces/api/login with email and password and using the returned bearer token directly. See the Login request in the AUTH folder for full details.
Destroys active app sessions. Calling POST /login invalidates the user's existing session token β if the same user is currently signed in to the report-book UI, they will be signed out.
Token expires after 7 days. You will need to re-login periodically. Each re-login produces a new token and (again) signs the user out of the app.
\nOnly one active session token per user at a time. Parallel integrations under the same user account will stomp on each other.
\nThe api token from section 4.1 has none of these downsides.
\nAfter the Affiliate Platform is set, iGsuite will be able to generate tracking links that will be used to track the customers of the affiliates. At this point, the iGaming Platform should proceed with the integration process.
\nEvery Affiliate who has signed in the Affiliate Platform will have a unique tracking link. The Affiliate uses this link to refer the customers towards the Operator Brand. The customer journey is as follows:
\nCustomer clicks on the affiliate link
\niGsuite tracking link redirects the customer to the given Landing Page by the Operator
\nA unique token is generated upon the redirect.
\nThis token is unique for every click
\nThrough this token, we track the Customers
\nThe customer token is generated by iGsuite and is unique for every single customer! The customer token is generated when the customer clicks on any of the Affiliate Platform tracking links.
\nExample of a Tracking Link: www.Affiliate-Platform-Domain.com/api/tracking-links/record?trackingLinkId=1&affiliateId=1
Example of where the Tracking Link will Redirect: www.Operator-Brand.com/signup?15bedea716ee7a35279520b61aa3d2a5
\nExample of the Customer Token:15bedea716ee7a35279520b61aa3d2a5
The iGaming Platform should ensure the following:
\nRequirements from the iGaming Operator:
\nTo store the customer token of the customer upon successful Registration
\nTo return the token of the customer within the Registration File
\nCustomer Token Specifications:
\nThe iGaming Platform may decode the token to collect and store the provided information in the previous point.
\nThe token is generated upon a click on the tracking links and itβs unique for each and every click.
\nThe iGaming Platform can decode the Customer Token in order to collect the embedded information for the customer via an API request.
\nThe integration is achieved through HTTPS or SFTP where we expect to receive consistently the given set of files in the agreed format.
\nIn order to ensure stable and consistent data flow without interruption, iGsuite requires that The iGaming Platform respects the following basic requirements:
\nThe IGaming Platform will always provide two files with a different set of data:
\nRegistration File (see Import Customers)
\nActivity File (see Import Activity)
\nThe iGaming Platform should always respect the data Format requirements for every column
\nEach column should have a single header only. To make the integration easier, the exact header names can be discussed and changed prior to beginning the process.
\nNote! All the fields in the CSV, JSON files and Body contents are subject to agreement between the two parties before beginning the daily integration process.
\nIf you choose to proceed with the SFTP integration approach, our team will grant you server access and dedicated credentials for your iGsuite platform. To complete the process, simply upload two files - registrations.csv and activities.csv - into the files directory at the agreed times. Once uploaded, our team will handle the rest, ensuring that your data is seamlessly available in your iGsuite platform.
\n\n\nNote: SFTP file uploads are not exercised in this collection. If you choose SFTP, the integration is arranged with our team outside Postman.
\n
Data integration is achieved via API integration with your iGsuite instance. This method offers a more streamlined and automated approach and reduces the risk of file upload failures.
\nThe API integration with iGsuite involves two separate requests for the customer registration and activity files, respectively. These requests can be made using the example requests provided below. The baseURL corresponds to the URL of the provided iGsuite instance, which will be communicated to you separately.
\nTo integrate data via API, a POST request is used to send the CSV file. The registration CSV file should adhere to the format described in Import Customers.
\nTo integrate data via API, a POST request is used to send the CSV file. The activities CSV file should adhere to the format described in Import Activity.
\nβ οΈ Note: Only customers who are affiliated with our system should be sent to us. Any customer record without an assigned affiliate or token must not be included in the import files. Submitting unregistered or unaffiliated customers will result in the files being rejected.
\nThe frequency of data imports is fully customizable, depending on your integration method:
\nAPI Integration: If you're sending data via direct API, you may import data at any preferred intervalβdaily, hourly, or even in real-time. However, it's important to ensure a 5-min delay between the customer registration import and the corresponding activity import. This allows the system to process and calculate the relevant metrics accurately.
\nSFTP Integration: If you choose to integrate via SFTP, please inform our team of your preferred import schedule during the initial integration setup. This enables us to configure the system accordingly and ensure timely and accurate data processing.
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28572506","collectionId":"a234ba01-2c09-4711-a83d-7f57c03a079a","publishedId":"2sA3s7k9k4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2B77FF"},"publishDate":"2025-01-09T11:38:33.000Z"},"item":[{"name":"AUTH","item":[{"name":"Get Api Token","id":"f3834732-cdb9-389a-9c01-c840a901754a","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/workspaces/api/api-token","description":"If the frequency of the import is Hourly or less, we insist on using overwrite method over merge.
\n
Returns metadata about the user's currently active long-lived api token, if one exists.
\n\n\nβ οΈ Auth requirements: this endpoint requires a 2FA-verified UI session token obtained via
\nLoginfollowed byVerify Token (2FA)if 2FA is enabled on the account. Long-lived api tokens cannot be used to call this endpoint by design β manage api tokens from a session that is already verified through the regular login flow, or use the report-book UI (Tools β Api Tokens).
No request body or query parameters.
\nThe user has an active api token. Returns its metadata. The plaintext token value is not included β it is only returned at mint time via Generate Api Token.
{\n \"id\": 47,\n \"createdAt\": \"2026-03-04T08:21:13.000Z\",\n \"lastUsedAt\": \"2026-05-10T14:09:55.000Z\"\n}\n\nThe user does not currently have an active api token.
\n{\n \"error\": \"No api token found\"\n}\n\nGenerates a new long-lived api token for the authenticated user. If the user already has an active api token, it is immediately invalidated and a new one is created.
\nThe plaintext token is returned once in this response β store it immediately, you will not be able to retrieve it again.
\n\n\nβ οΈ Auth requirements: this endpoint requires a 2FA-verified UI session token obtained via
\nLoginfollowed byVerify Token (2FA)if 2FA is enabled on the account. Long-lived api tokens cannot mint a new api token by design. The same operation is available without programmatic auth via the report-book UI (Tools β Api Tokens), which is the recommended path.
No request body or query parameters.
\n{\n \"id\": 47,\n \"createdAt\": \"2026-05-11T08:21:13.000Z\",\n \"token\": \"opaque-plaintext-token-shown-once\"\n}\n\nRevokes the user's currently active long-lived api token. Subsequent requests using the revoked token return 401 Unauthorized.
\n\nβ οΈ Auth requirements: this endpoint requires a 2FA-verified UI session token obtained via
\nLoginfollowed byVerify Token (2FA)if 2FA is enabled on the account. Long-lived api tokens cannot revoke themselves by design. The same operation is available via the report-book UI (Tools β Api Tokens β Disable).
No request body or query parameters.
\nThe api token was successfully revoked. The user has no active api token after this call.
\n","urlObject":{"path":["workspaces","api","api-token"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b5201070-e4ba-a75b-81b2-4b86315a830b"},{"name":"Login","event":[{"listen":"test","script":{"id":"634f8ec3-3ed7-48ab-a0d2-db21b4592cd0","exec":["var token = pm.response.json().token","pm.environment.set(\"token\", token)","postman.setEnvironmentVariable(\"token\", token);",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"442fc0b0-5762-40f4-868a-5646bd47fa72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.smith@email.com\",\n \"password\": \"password123\"\n}"},"url":"/workspaces/api/login","description":"This API endpoint authenticates a user and returns a short-lived session bearer token for use against /api/* endpoints.
\n\nβ οΈ For programmatic API integrations, this is the not-recommended path. The recommended way to authenticate a service is to obtain a long-lived api token via the report-book UI β see section 4.1 of the collection overview. The flow described below has significant downsides β see section 4.2.
\n
email (string, required): The email address of the user.
password (string, required): The password of the user.
Upon successful login, the server returns:
\ntoken β the bearer token to send as Authorization: Bearer <token> on subsequent requests.
requiresTwoFactorAuthentication β if true, the token is unverified and must be verified by calling Verify Token (2FA) with the code emailed to the user before it can be used on most endpoints.
{\n \"token\": \"opaque-bearer-token-value\",\n \"type\": \"client\",\n \"requiresTwoFactorAuthentication\": true\n}\n\nShort-lived: the session token expires after 7 days. After expiration, requests return 401 Unauthorized. Generate a new one by logging in again.
Session-bound: logging in via POST /login invalidates the user's previous active session token, including the one their active app session may be using. Performing this login while a person is signed in to the report-book UI under the same account will sign them out.
One active session token per user at a time. You cannot run parallel integrations under the same user account this way without them stomping on each other.
\nReturned when the supplied credentials are invalid, or when the account is not allowed to authenticate (e.g. it has been disabled).
\n{\n \"error\": \"Invalid credentials!\"\n}\n\nReturned when the request body fails validation (e.g. email or password missing).
The endpoint is used for token verification, given that you've got 2-Factor Authentication enabled. Upon logging in, a code will be sent to the email address associated with the account in question. This exact code should be included in the request body.
\ncode (string, required): The code to be verified.The session token was successfully verified. Subsequent requests using it pass the requireTwoFactor middleware. Returns an empty body.
The supplied code does not match the one issued for the current session, or the code has expired.
\n{\n \"error\": \"Invalid verification code\"\n}\n\nReturned when code is missing from the request body.
This endpoint returns a paginated list of affiliates. By default the response includes all affiliates the requester has access to, ordered newest first. The list can be narrowed via optional query parameters.
\nAll query parameters are optional:
\ntype (string) β Filter by affiliate status. One of: approved, rejected, waiting, suspended. Returns 422 Unprocessable Entity if any other value is supplied.
search (string) β Substring match against affiliate name, username, email, website, or numeric id.
page (integer) β Page number (>= 1). Default: 1.
perPage (integer) β Page size. Default: 15.
Filters compose: ?type=approved&search=nik returns approved affiliates whose name/username/email/website contains \"nik\".
Returns a JSON object with two top-level keys:
\nmeta β pagination information (total records, perPage, currentPage, lastPage, firstPage, etc.).
data β array of affiliate objects.
Returned when type is not one of the allowed values listed above.
{\n \"errors\": [\n { \"field\": \"type\", \"message\": \"The selected type is invalid\", \"rule\": \"enum\" }\n ]\n}\n\nFilter by affiliate status. One of: approved, rejected, waiting, suspended.
\n","type":"text/plain"},"key":"type","value":"approved"},{"disabled":true,"description":{"content":"Substring match against affiliate name, username, email, website, or numeric id.
\n","type":"text/plain"},"key":"search","value":"nik"},{"disabled":true,"description":{"content":"Page number (>= 1). Default: 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Page size. Default: 15.
\n","type":"text/plain"},"key":"perPage","value":"15"}],"variable":[]}},"response":[{"id":"cf658dc1-9346-4ff3-ae46-aaf0bdd2e037","name":"Affiliates","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"/workspaces/api/affiliates?type=approved","path":["workspaces","api","affiliates"],"query":[{"key":"type","value":"approved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Sep 2024 11:30:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-ratelimit-limit","value":"600"},{"key":"x-ratelimit-remaining","value":"599"},{"key":"x-do-app-origin","value":"c3e1d531-2936-4810-8479-54fa5cf2030c"},{"key":"Cache-Control","value":"private"},{"key":"x-do-orig-status","value":"200"},{"key":"Last-Modified","value":"Tue, 24 Sep 2024 11:30:16 GMT"},{"key":"CF-Cache-Status","value":"MISS"},{"key":"Set-Cookie","value":"__cf_bm=hKUEi3TwQDuBtpX7FmCB7egkljvDXNkRTl5hek.4gqs-1727177416-1.0.1.1-hM9aZV4NqAzb2c2h0y.A.Kh.8RsHSVo97pk.J4vIAbyy9xyY8OUyz0JG7Ym8RWaM5HJD0Y7EatNOe9o_xR4UOg; path=/; expires=Tue, 24-Sep-24 12:00:16 GMT; domain=.develop.report-book.com; HttpOnly; Secure; SameSite=None"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c8271060a34d0ea-SOF"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"total\": 15784,\n \"perPage\": 15,\n \"currentPage\": 1,\n \"lastPage\": 1053,\n \"firstPage\": 1,\n \"firstPageUrl\": \"/?page=1\",\n \"lastPageUrl\": \"/?page=1053\",\n \"nextPageUrl\": \"/?page=2\",\n \"previousPageUrl\": null\n },\n \"data\": [\n {\n \"id\": 1,\n \"email\": \"niki@email.com\",\n \"username\": \"niki\",\n \"name\": \"Nicholas Smith\",\n \"statusReason\": \"\",\n \"masterAffiliateId\": null,\n \"approved\": \"2023-05-19T08:07:38.840+00:00\",\n \"rejected\": null,\n \"suspended\": null,\n \"createdAt\": \"2023-04-12T06:32:36.455+00:00\",\n \"updatedAt\": \"2023-11-28T02:20:00.041+00:00\",\n \"twoFactorAuthMethod\": \"email\",\n \"labelId\": 3,\n \"label\": {\n \"id\": 3,\n \"name\": \"dormant\"\n },\n \"affiliateProfile\": {\n \"id\": 5,\n \"website\": \"https://front-butter.com\",\n \"paymentType\": \"Other\",\n \"expectedVolumes\": \"1-10 FTD's\",\n \"businessModel\": \"Hybrid\",\n \"agreedToTerms\": null,\n \"receivePromotionalMaterials\": \"2023-04-12T06:32:36.608+00:00\",\n \"receiveUpdates\": \"2023-04-12T06:32:36.608+00:00\",\n \"affiliateId\": 11,\n \"firstTimeActive\": null,\n \"registeredAt\": \"2021-10-14T23:00:07.706+00:00\",\n \"createdAt\": \"2023-04-12T06:32:36.609+00:00\",\n \"updatedAt\": \"2023-04-12T06:32:36.609+00:00\",\n \"address\": null,\n \"city\": null,\n \"zipCode\": null,\n \"taxNumber\": null,\n \"countryId\": null,\n \"companyName\": null,\n \"mainProduct\": null,\n \"trafficSourceId\": 7\n }\n },\n ...\n ]\n}"}],"_postman_id":"5f230c83-44b3-4930-ac7c-7ee827bc0c70"},{"name":"Affiliate","event":[{"listen":"test","script":{"id":"72ad6de9-167f-479e-9250-a537b6682b28","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"98e42015-2d39-466b-9af4-5590eed37ac3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/workspaces/api/affiliates/1","description":"This endpoint retrieves the details of a specific affiliate based on the provided id in the URL path. A request to /workspaces/api/affiliates/1 would return information about the affiliate with id 1.
No request body is required for this endpoint.
\nThe response will be a JSON object containing information about the affiliate in question, their role, permissions and manager.
\nIf the provided id does not correspond to an affiliate user, the response will be the following:
{\n \"error\": \"User is not an affiliate\"\n }\n\nThis endpoint retrieves the details of a specific customer based on the provided id in the URL path. A request to /workspaces/api/customers/1 would return information about the customer with id 1.
No request body is required for this endpoint.
\nThe response will be a JSON object containing information about the customer and their activities.
\n","urlObject":{"path":["workspaces","api","customers","1"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5ffa736d-8498-4cc4-9b26-99749d236234","name":"Customer","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/workspaces/api/customers/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"3115"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 21 Aug 2024 06:49:36 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"externalCustomerId\": \"4e93dc11-da3f-4f14-8591-f200cca48a0e\",\n \"token\": null,\n \"externalCustomerStatus\": null,\n \"qualifiedCpaAt\": null,\n \"countryId\": 69,\n \"affiliateId\": 11,\n \"brandId\": 4,\n \"dealId\": 50,\n \"registrationTrackingLinkClickId\": null,\n \"firstTimeActive\": \"2024-08-19T00:00:00.000+03:00\",\n \"registeredAt\": \"2024-08-20T00:00:00.000+03:00\",\n \"createdAt\": \"2024-08-20T09:15:00.376+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.565+03:00\",\n \"activities\": [\n {\n \"id\": 1,\n \"ftd\": true,\n \"ftdAmount\": 500,\n \"depositsAmount\": 500,\n \"withdrawalsAmount\": 10,\n \"betsAmount\": 500,\n \"winsAmount\": 100,\n \"bonusCost\": 100,\n \"ggr\": 400,\n \"adminFee\": 100,\n \"ngr\": 296,\n \"totalFees\": 4,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:00.455+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 6,\n \"meta\": {\n \"through_customer_id\": 1\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"535b2c7d-902f-4d04-a465-962fcff27ec4"},{"name":"Customers","id":"e770710d-8ce0-472f-a93d-839479b1e616","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/workspaces/api/customers","description":"The endpoint retrieves a list of customers with pagination support. It accepts optional parameters for page number and items per page (refer to the Query Params section). If omitted, default pagination parameters will be used.
\nNo request body is required for this endpoint.
\nA successful response returns a JSON object with two main keys:
\nmeta: This key contains pagination information, such as the total number of records, the number of records per page, the current page, etc.
data: This key holds an array of objects containing data about customers, along with their respective activities.
Page number (>= 1). Default: 1
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Results per page. Default: 15
\n","type":"text/plain"},"key":"perPage","value":"15"}],"variable":[]}},"response":[{"id":"74831515-9d2c-4680-993b-1cafd5d45b1b","name":"Customers","originalRequest":{"method":"GET","header":[{"key":"page","value":"2","type":"text","disabled":true},{"key":"perPage","value":"15","type":"text","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/workspaces/api/customers?page=1&perPage=2","path":["workspaces","api","customers"],"query":[{"key":"page","value":"1"},{"key":"perPage","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"4201"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 21 Aug 2024 06:51:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"total\": 25,\n \"perPage\": 2,\n \"currentPage\": 1,\n \"lastPage\": 13,\n \"firstPage\": 1,\n \"firstPageUrl\": \"/?page=1\",\n \"lastPageUrl\": \"/?page=13\",\n \"nextPageUrl\": \"/?page=2\",\n \"previousPageUrl\": null\n },\n \"data\": [\n {\n \"id\": 17,\n \"externalCustomerId\": \"56789\",\n \"token\": \"token12345\",\n \"externalCustomerStatus\": \"Duplicate Account\",\n \"qualifiedCpaAt\": null,\n \"countryId\": 136,\n \"affiliateId\": 16,\n \"brandId\": 2,\n \"dealId\": 50,\n \"registrationTrackingLinkClickId\": null,\n \"firstTimeActive\": \"2024-08-20T00:00:00.000+03:00\",\n \"registeredAt\": \"2024-08-20T00:00:00.000+03:00\",\n \"createdAt\": \"2024-08-20T09:15:02.447+03:00\",\n \"updatedAt\": \"2024-08-20T14:43:41.544+03:00\",\n \"activities\": [\n {\n \"id\": 71,\n \"ftd\": true,\n \"ftdAmount\": 50,\n \"depositsAmount\": 30290,\n \"withdrawalsAmount\": 10520,\n \"betsAmount\": 70016,\n \"winsAmount\": 12004,\n \"bonusCost\": 37,\n \"ggr\": 58012,\n \"adminFee\": 14503,\n \"ngr\": 57394.88,\n \"totalFees\": 580.12,\n \"depositsCount\": 3,\n \"createdAt\": \"2024-08-20T09:15:02.501+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 86,\n \"meta\": {\n \"through_customer_id\": 17\n }\n },\n {\n \"id\": 74,\n \"ftd\": false,\n \"ftdAmount\": 0,\n \"depositsAmount\": 50,\n \"withdrawalsAmount\": 3500,\n \"betsAmount\": 70000,\n \"winsAmount\": 12000,\n \"bonusCost\": 150,\n \"ggr\": 58000,\n \"adminFee\": 14500,\n \"ngr\": 57270,\n \"totalFees\": 580,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:02.560+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 91,\n \"meta\": {\n \"through_customer_id\": 17\n }\n },\n {\n \"id\": 75,\n \"ftd\": false,\n \"ftdAmount\": 0,\n \"depositsAmount\": 15120,\n \"withdrawalsAmount\": 3510,\n \"betsAmount\": 800,\n \"winsAmount\": 20,\n \"bonusCost\": 50,\n \"ggr\": 780,\n \"adminFee\": 195,\n \"ngr\": 722.2,\n \"totalFees\": 7.8,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:02.580+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 92,\n \"meta\": {\n \"through_customer_id\": 17\n }\n },\n {\n \"id\": 76,\n \"ftd\": false,\n \"ftdAmount\": 0,\n \"depositsAmount\": 15920,\n \"withdrawalsAmount\": 3520,\n \"betsAmount\": 200,\n \"winsAmount\": 0,\n \"bonusCost\": 150,\n \"ggr\": 200,\n \"adminFee\": 50,\n \"ngr\": 48,\n \"totalFees\": 2,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:02.599+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 93,\n \"meta\": {\n \"through_customer_id\": 17\n }\n }\n ],\n \"meta\": {}\n },\n {\n \"id\": 16,\n \"externalCustomerId\": \"5678910\",\n \"token\": \"token123456\",\n \"externalCustomerStatus\": \"Confirmed Fraud\",\n \"qualifiedCpaAt\": null,\n \"countryId\": 23,\n \"affiliateId\": 16,\n \"brandId\": 2,\n \"dealId\": 50,\n \"registrationTrackingLinkClickId\": null,\n \"firstTimeActive\": \"2024-08-20T00:00:00.000+03:00\",\n \"registeredAt\": \"2024-08-20T00:00:00.000+03:00\",\n \"createdAt\": \"2024-08-20T09:15:02.447+03:00\",\n \"updatedAt\": \"2024-08-20T14:43:41.544+03:00\",\n \"activities\": [\n {\n \"id\": 87,\n \"ftd\": false,\n \"ftdAmount\": 0,\n \"depositsAmount\": 705,\n \"withdrawalsAmount\": 0,\n \"betsAmount\": 8916.27,\n \"winsAmount\": 8078.1,\n \"bonusCost\": 134.52,\n \"ggr\": 838.17,\n \"adminFee\": 209.54,\n \"ngr\": 703.65,\n \"totalFees\": 0,\n \"depositsCount\": 2,\n \"createdAt\": \"2024-08-20T13:22:24.734+03:00\",\n \"updatedAt\": \"2024-08-20T13:55:24.817+03:00\",\n \"dealActionId\": 123,\n \"meta\": {\n \"through_customer_id\": 16\n }\n },\n {\n \"id\": 77,\n \"ftd\": true,\n \"ftdAmount\": 50,\n \"depositsAmount\": 30290,\n \"withdrawalsAmount\": 10520,\n \"betsAmount\": 70016,\n \"winsAmount\": 12004,\n \"bonusCost\": 37,\n \"ggr\": 58012,\n \"adminFee\": 14503,\n \"ngr\": 55615.86,\n \"totalFees\": 2359.14,\n \"depositsCount\": 3,\n \"createdAt\": \"2024-08-20T09:15:02.619+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 87,\n \"meta\": {\n \"through_customer_id\": 16\n }\n },\n {\n \"id\": 80,\n \"ftd\": false,\n \"ftdAmount\": 0,\n \"depositsAmount\": 50,\n \"withdrawalsAmount\": 3500,\n \"betsAmount\": 70000,\n \"winsAmount\": 12000,\n \"bonusCost\": 150,\n \"ggr\": 58000,\n \"adminFee\": 14500,\n \"ngr\": 56792.5,\n \"totalFees\": 1057.5,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:02.672+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 97,\n \"meta\": {\n \"through_customer_id\": 16\n }\n },\n {\n \"id\": 81,\n \"ftd\": false,\n \"ftdAmount\": 0,\n \"depositsAmount\": 15120,\n \"withdrawalsAmount\": 3510,\n \"betsAmount\": 800,\n \"winsAmount\": 20,\n \"bonusCost\": 50,\n \"ggr\": 780,\n \"adminFee\": 195,\n \"ngr\": 63.7,\n \"totalFees\": 666.3,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:02.689+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 98,\n \"meta\": {\n \"through_customer_id\": 16\n }\n },\n {\n \"id\": 82,\n \"ftd\": false,\n \"ftdAmount\": 0,\n \"depositsAmount\": 15920,\n \"withdrawalsAmount\": 3520,\n \"betsAmount\": 200,\n \"winsAmount\": 0,\n \"bonusCost\": 150,\n \"ggr\": 200,\n \"adminFee\": 50,\n \"ngr\": -644.4,\n \"totalFees\": 694.4,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:02.705+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 99,\n \"meta\": {\n \"through_customer_id\": 16\n }\n }\n ],\n \"meta\": {}\n }\n ]\n}"}],"_postman_id":"e770710d-8ce0-472f-a93d-839479b1e616"},{"name":"Import Customers","event":[{"listen":"test","script":{"id":"e733c894-bff4-47b6-8803-448d10d7e73a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"515b2251-88b6-4007-bd56-68044b9ccc54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":"","key":"file","type":"file"},{"value":"(Optional) A specific Platform configuration to use for the imported data.
\n","key":"platform","type":"text","disabled":true}]},"url":"/workspaces/api/customers/import","description":"This endpoint allows you to import customer data via file or json body.
file import
The request body should be of type form-data, with a key \"file\" of type File.
The format of the file could be either csv, xlsx or json
It is recommended that the Content-Type header is set to multipart/form-data
json body import
The request body should be a json object in the file information format described below
\nIt is recommended that the Content-Type header is set to application/json
Regardless of the format, the headers included in the file should be the following:
\nCustomer - this field should contain the id of the customer.
Token (optional) - this field should contain the token of the customer, if they have such.
Customer Join Date - date on which the customer joined the platform in format - DD/MM/YYYY.
Customer Country - this field should contain the country from which the customer registered. It can either be the full country name or the country code based on ISO 3166-1 alpha-2/3
Brand - this field should contain the brand under which the customer is.
Affiliate - the username of the Affiliate under which the customer has been registered.
CPA Excluded - whether the Customer should be permanently excluded from CPA generation.
Nickname (optional) - a free-form display name for the customer, such as their name, email, or username. We store it exactly as you send it, with no formatting rules applied. Send the customer again with a different nickname to update it. See Re-importing a customer below.
\n\nThese are the default headers. As per our Client Integration documentation, their names can be completely and freely customized by communicating this need with our administration team.
\n
Send a customer we already hold and we update their Nickname. Everything else recorded at their first import stays as it was: affiliate, country, join date and CPA exclusion. A re-import corrects a display name, it never re-attributes a customer.
Send a different, non-empty Nickname to replace the stored one.
Leave Nickname empty, or omit the column, to keep the stored one. An empty value never clears a nickname.
A file that only refreshed nicknames is a successful import (201), not an empty one (200).
Send a customer we already hold with nothing to change and the row is skipped, exactly as before.
\nName the same customer twice in one file and we take the first occurrence.
\nfile (file): The file containing the activities to be imported. It can either be csv, xlsx or jsonOR
\n// An array of objects with imported data in described format\n[\n {\n \"Brand\": \"BrandName\",\n \"Affiliate\": \"AffiliateUsername\",\n \"Nickname\": \"playerOne\",\n // ...rest of the keys mentioned in File Information (or different, if configured otherwise)\n }\n]\n\nReturned when the request succeeded but there was nothing to import. The file was empty, contained data we could not recognize at all, or named only customers we already hold with nothing about them to change.
\n{\n \"message\": \"There is no new data to import from this file.\"\n}\n\nReturned when every row was valid and imported, including rows that only refreshed the nickname of a customer we already hold. Further processing happens in the background, so a customer's registration and display in the platform can lag behind this response.
\n{\n \"message\": \"Customer data imported successfully\"\n}\n\nThis response will be returned when some rows have been found to contain invalid data values, but not all. In this case we'll parse and import all valid rows and collect error information for the invalid ones with details as to why the data is considered to be invalid and we are not able to import these rows.
\n{\n \"message\": \"Customer data partially imported\",\n \"details\": {\n \"imported\": 18,\n \"skipped\": 2\n },\n \"errors\": [\n {\n \"column\": \"Customer\",\n \"message\": \"Values are invalid or do not exist\",\n \"rows\": [4, 9],\n \"values\": [\"1005\", \"1006\"]\n }\n ]\n}\n\nThis response will be returned upon receiving an invalid file or file that is missing information, such as a required column with data for the type of import.
\n{\n \"error\": \"Invalid Customer values: 1005\",\n \"column\": \"Customer\",\n \"reason\": \"Invalid 'Customer' values 1005.\"\n}\n\nReturned when the upload exceeds the maximum size. Import files may be up to 20 MB, measured across the whole request body (including the file). Larger uploads are rejected before any rows are processed.
\n {\n \"message\": \"request entity too large\"\n }\n\nThis response will be returned when too many import requests have been sent in a short period of time among all import endpoints, including both customers and activities.
\nCurrent rate allows for 10 requests per 1 minute.
\n","urlObject":{"path":["workspaces","api","customers","import"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"1177fa2f-31c4-4a84-82f3-2b67f76202b8","name":"CSV Customers Import","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"platform","value":"(Optional) A specific Platform configuration to use for the imported data.
\n","key":"platform","type":"text","disabled":true}]},"url":"/workspaces/api/customers/status-import","description":"This endpoint allows you to import customer status data via file or json body.
file import
The request body should be of type form-data, with a key \"file\" of type File.
The format of the file could be either csv, xlsx or json
It is recommended that the Content-Type header is set to multipart/form-data
json body import
The request body should be a json object in the file information format described below
\nContent-Type header is set to application/jsonRegardless of the format, the headers included in the file should be the following:
\nCustomer - this field should contain the id of the customer
Status - this field should contain the status of the customer.
\n\nThese are the default headers. As per our Client Integration documentation, their names can be completely and freely customized by communicating this need with our administration team.
\n
\n\nWe also support multiple Configurations per single Instance. This means that you can perform different imports with varying headers and other options. Configuration for the ongoing import request is selected by providing a valid
\nplatformparameter, associated with an additional configuration, along with the data to import.
file (file): The file containing the data to be imported. It can either be csv, xlsx or json.platform (string, optional): A specific Platform configuration to use for the imported data. Only required if you have more than one brand and want to target a specific Platform configuration.OR
\n{\n \"platform\": \"BrandName\", // Can be omitted if you only have one brand\n \"data\": [\n // Array of objects with imported data in described format\n ]\n}\n\nThis response will be returned when the request was successfully, but we found no data to import. Either the file was empty, contained data that we could not recognize at all, or all of its contents are already present on our side.
\n{\n \"message\": \"There is no new data to import from this file.\"\n}\n\nThis response will be returned when all of the rows were valid and successfully imported. Further processing will happen in the background, and their ultimate registration and display in the platform might lag behind this.
\n{\n \"message\": \"Customer status data imported successfully!\"\n}\n\nThis response will be returned upon receiving an invalid file or file that is missing information, such as a required column with data for the type of import. The example shows an attempt to import data for missing customer with id 1005.
\n{\n \"error\": \"Invalid Customer values: 1005\",\n \"column\": \"Customer\",\n \"reason\": \"Invalid 'Customer' values 1005.\"\n}\n\nReturned when the upload exceeds the maximum size. Import files may be up to 20 MB, measured across the whole request body (including the file). Larger uploads are rejected before any rows are processed.
\n {\n \"message\": \"request entity too large\"\n }\n\nThis response will be returned when too many import requests have been sent in a short period of time among all import endpoints, including both customers and activities.
\nCurrent rate allows for 10 requests per 1 minute.
\n","urlObject":{"path":["workspaces","api","customers","status-import"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d9a3c95b-9254-4b7b-ad49-0f22541bee42","name":"CSV Customer Status Import","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"platform","value":"This endpoint retrieves activity details for a specific customer based on the id provided in the URL path. A request to /workspaces/api/activities/1 would return information about the activities of the customer with id 1.
This endpoint does not require a request body.
\nThe response body returns an array of activity objects. An example response body can be seen below.
\n","urlObject":{"path":["workspaces","api","activities","1"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"ee764380-b69b-4d82-8d36-69b6ffafa2d8","name":"Get Activity by Customer ID","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/workspaces/api/activities/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"315"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 21 Aug 2024 06:56:46 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 70,\n \"ftd\": true,\n \"ftdAmount\": 500,\n \"depositsAmount\": 500,\n \"withdrawalsAmount\": 10,\n \"betsAmount\": 500,\n \"winsAmount\": 100,\n \"bonusCost\": 100,\n \"ggr\": 400,\n \"adminFee\": 100,\n \"ngr\": 296,\n \"totalFees\": 4,\n \"depositsCount\": 1,\n \"createdAt\": \"2024-08-20T09:15:01.755+03:00\",\n \"updatedAt\": \"2024-08-20T09:15:04.549+03:00\",\n \"dealActionId\": 85,\n \"meta\": {}\n }\n]"}],"_postman_id":"078ca278-afd6-48a4-83c6-137ce1bed93e"},{"name":"Import Activity Data","event":[{"listen":"test","script":{"id":"5472aadf-7b50-4bb3-a498-ee1eb2f20e3a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"799ceec7-e632-4e3b-a8e2-e733fbe2b9c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"type":"file","key":"file","value":""},{"key":"platform","value":"(Optional) A specific Platform configuration to use for the imported data.
\n","disabled":true}]},"url":"/workspaces/api/activities/import","description":"This endpoint allows the user to import activities via file or json body.
file import
The request body should be of type form-data, with a key \"file\" of type File.
The format of the file could be either csv, xlsx or json
It is recommended that the Content-Type header is set to multipart/form-data
json body import
The request body should be a json object in the file information format described below
\nIt is recommended that the Content-Type header is set to application/json
You may want to integrate some of the activity data as soon as possible. For example, we might want to reflect the FTD status and amount of the customer as soon as it is available. This endpoint can receive data multiple times. It means that data can be sent partially or incrementally in pieces.
\nFor example, it can only receive FTD (or any other column) information, as soon as it is available, and then receive all other values later on. In order to do this, simply provide the values that are known at the time, and leave all other required values as 0 (optional values can be skipped, as always). As other values become available they can be sent via this endpoint in a similar manner.
\n\n\nDepending on the import mode configured on integration, subsequent imports will either merge (incremental import) or overwrite (partial import) existing data.
\n
file (file): The file containing the activities to be imported. It can either be csv, xlsx or jsonOR
\n// An array of objects with imported data in described format\n[\n {\n \"Customer\": \"CustomerId\",\n \"Affiliate\": \"AffiliateUsername\",\n // ...rest of the keys configured based on the File Information section below\n }\n]\n\nRegardless of the format (csv or xlsx), the headers included in the file should be the following:
Customer - this field should contain the id of the customer. Required when country and affiliate are missing, optional otherwise.
Affiliate - the username of the Affiliate under which the customer has been registered. Required with Country when Customer value is missing, optional otherwise.
Country - the country of origin for the activity. When customer is present, it must match the country of the customer. Required with Affiliate when Customer value is missing, optional otherwise.
Date - date on which the activity occurred. Format - DD/MM/YYYY.
FTD (number) - Whether or not this is a First Time Deposit. 1 should be passed for true, and 0 for false.
Ftd Amount - Amount of the first time deposit. If the activity is not FTD related, the imported value will be 0.
Total Deposits - Total amount of deposits during the given date.
Deposit Count (optional) - The number of deposits made within the current activity batch. Default: 1.
Withdrawals - The withdrawal amount made by the customer during the given date.
Casino Bets - The customer total bet amount placed during the given date on the Casino Product.
Casino Wins - The customer total win amount settled during the given date on the Casino Product.
Bonus Cost - This is the total Bonus Cost which the customer accumulated during the given date.
Brand - The brand name on which the activity happened
\n\nThese are the default headers. As per our Client Integration documentation, their names can be completely and freely customized by communicating this need with our administration team.
\n
This response will be returned when the request was successfully, but we found no data to import. Either the file was empty, contained data that we could not recognize at all, or all of its contents are already present on our side.
\n{\n \"message\": \"There is no new data to import from this file.\"\n}\n\nThis response will be returned when all of the rows were valid and successfully imported. Further processing will happen in the background, and their ultimate registration and display in the platform might lag behind this.
\n{\n \"message\": \"Activity data imported successfully\"\n}\n\nThis response will be returned when some rows have been found to contain invalid data values, but not all. In this case we'll parse and import all valid rows and collect error information for the invalid ones with details as to why the data is considered to be invalid and we are not able to import these rows.
\n{\n \"message\": \"Activity data partially imported\",\n \"details\": {\n \"imported\": 18,\n \"skipped\": 2\n },\n \"errors\": [\n {\n \"column\": \"Customer\",\n \"message\": \"Values are invalid or do not exist\",\n \"rows\": [4, 9],\n \"values\": [\"1005\", \"1006\"]\n }\n ]\n}\n\nThis response will be returned upon receiving an invalid file or file that is missing information, such as a required column with data for the type of import.
\n{\n \"error\": \"Invalid Customer values: 1005\",\n \"column\": \"Customer\",\n \"reason\": \"Invalid 'Customer' values 1005.\"\n}\n\nReturned when the upload exceeds the maximum size. Import files may be up to 20 MB, measured across the whole request body (including the file). Larger uploads are rejected before any rows are processed.
\n {\n \"message\": \"request entity too large\"\n }\n\nThis response will be returned when too many import requests have been sent in a short period of time among all import endpoints, including both customers and activities.
\nCurrent rate allows for 10 requests per 1 minute.
\n","urlObject":{"path":["workspaces","api","activities","import"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"e6fa8737-0dd1-4775-9d81-c9ef97a931c3","name":"CSV Activity Import","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"platform","value":"Reference only β your integration never calls this endpoint. The customer's browser calls it when the customer clicks an affiliate's tracking link.
\niGsuite records the click, generates the customer token, and answers with a 301 Moved Permanently to the landing page configured on the tracking link. Read this to know exactly what arrives on your landing page URL.
Every tracking link is a single URL carrying a unique link identifier:
\nhttps://www.Affiliate-Platform-Domain.com/t/1f5c9e04-8a3d-4c77-9b21-6de0f2a7c418\n\nAffiliates take the link from the Affiliate Platform as it is given to them. This is the format you should expect to see in circulation.
\nLink identifier (required): the path segment after /t/. Nothing needs to be added to it or read out of it.
clickId (string, optional): the affiliate's own click identifier, up to 2048 characters. Returned as externalAffiliateClickId when you decode the customer token.
A tracking link also accepts any dynamic variables configured for your platform, passed as query parameters named exactly as the variable. Query parameters that do not match a configured variable are ignored.
\nSay a dynamic variable named subid is configured for your platform, and an affiliate wants to mark the clicks coming from their newsletter. They append it to their tracking link:
https://www.Affiliate-Platform-Domain.com/t/1f5c9e04-8a3d-4c77-9b21-6de0f2a7c418?subid=newsletter-42\n\nThe click is then recorded with subid set to newsletter-42, and the value becomes available in iGsuite reporting.
Dynamic variables are recorded against the click only. They are not forwarded to your landing page URL and are not part of the decoded customer token, so there is nothing for you to read or store on your side.
\nThe Location header carries the landing page URL with the parameters below appended. Query parameters and the hash fragment already present on the configured landing page are preserved.
https://www.operator-brand.com/signup?btag=15bedea716ee7a35279520b61aa3d2a5&ai=142\n\nReading that example parameter by parameter:
\nbtag is the token parameter name configured for this platform, so 15bedea716ee7a35279520b61aa3d2a5 is the customer token. This is the value to store against the customer on registration and return in the Registration File, and the value to pass to Decode Customer Token.
ai is the affiliate id, so the click belongs to affiliate 142.
btag is only an example. Your token parameter name is agreed with us during integration and is most likely something else β if you are not certain which parameter on your landing page carries the token, ask us and we will confirm it for your platform.
The affiliate id lets you attribute a landing page visit to an affiliate immediately, without decoding the customer token first. It does not replace the token: the customer token stays the value you store on registration and return in the Registration File.
\nReturned when the link identifier does not match a tracking link.
\n{\n \"error\": \"Invalid tracking link\"\n}\n\nReturned when clickId is longer than 2048 characters.
{\n \"errors\": [\n { \"field\": \"clickId\", \"message\": \"...\", \"rule\": \"...\" }\n ]\n}\n\nReturned when too many clicks are recorded from the same client in a short period. Current rate allows for 15 requests per 15 seconds.
\nYou may still come across an older link format:
\nhttps://www.Affiliate-Platform-Domain.com/api/tracking-links/record?trackingLinkId=1&affiliateId=1\n\nThose links keep working and append the same landing page parameters, so there is nothing to fix on your side. New integrations should use the link format above. The only difference you can observe is the 404 body, which reads Invalid tracking link ID.
This endpoint retrieves information about a customer based on an encoded token associated with a tracking link click.
\nLeave a short delay between the click and your call. Clicks are processed through a queue rather than stored the moment the customer is redirected, so a token asked for in the first seconds may not be resolvable yet. About a minute after the click is enough in practice.
\nThe response will be in JSON format and will represent the decoded information the token holds. See the example for reference.
\nReturned when the token query parameter is missing or does not match a recorded click.
\n{\n \"errors\": [\n { \"field\": \"token\", \"message\": \"...\", \"rule\": \"...\" }\n ]\n}\nLookups for a token we can already resolve are not rate limited. Lookups for a token we cannot resolve β one that has not been through the queue yet, or one that does not exist β are limited to 100 requests per day.
\nThis is the reason for the short delay above. Polling immediately after a click, or retrying a token in a tight loop, spends that daily allowance on clicks that would have resolved on their own a moment later.
\n","urlObject":{"path":["workspaces","api","tracking-links","decode-token"],"host":[""],"query":[{"key":"token","value":"a3a785a961b603b03c738cb8136055bb"}],"variable":[]}},"response":[{"id":"6219ee6e-df04-4d7e-8ef0-d582c55c0ad3","name":"Decode Customer Token","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/workspaces/api/tracking-links/decode-token?token=a3a785a961b603b03c738cb8136055bb","path":["workspaces","api","tracking-links","decode-token"],"query":[{"key":"token","value":"a3a785a961b603b03c738cb8136055bb"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"202"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 24 Sep 2024 12:28:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":" {\n \"affiliateId\": 1,\n \"username\": \"niki\",\n \"ipAddress\": \"123.45.67.89\",\n \"referralLink\": null,\n \"externalAffiliateClickId\": \"abc123def456\",\n \"trafficSource\": \"SEO\",\n \"trackingLinkId\": 1,\n \"brandId\": 2,\n \"brandName\": \"brandCool\",\n \"campaignId\": 5,\n \"campaignName\": \"Spring Promo\"\n }"}],"_postman_id":"5ddce0c7-c486-4ebc-8fb5-8129ad6326d3"}],"id":"9cbdac48-55d0-44be-8d4f-f0c75af64b41","description":"Links and clicks are the primary tracking instrument. Every tracking link click tells you two things: which affiliate sent the customer, and the client details (campaign, referring URL, traffic source, dynamic variables, etc.). How to collect each of them?
\n1. Affiliate ID β β Best is to read it from the landing page URL
\nEach redirect appends it as the ai parameter on your landing page URL as part of its query parameters (search string), e.g. ai=277 -> 277 is the affiliate ID.
This is our recommended way to attribute a customer to an affiliate.
\n2. Everything else β decode the customer token
\nResolves to campaign, referring URL, traffic source, brand, the affiliate's click ID, and more.
\nEndpoint: Decode Customer Token
\nβΉοΈ Tip: Decoding of the token is not immediately avaialbe. You should set up your script to start with a delay of 2-3 minutes or to run after the registration customer registration process is complete on your end.
\nReason for the delay: Clicks are processed in a queue, and not immediately at redirect time β a token requested immediately after the landing page is hit, or in the first few seconds afte rthat may not yet resolve to the full details; failed lookups are rate limited for security reasons so be warned.
\nNormally clicks are completely processed within no more than a few seconds; under heavy traffic it can take a bit longer.
\nThis API endpoint is used to obtain traffic (tracking link) data.
\npage (integer) - The page of results that is being requested. Can be any number >= 1.
Default: 1perPage (integer) - How many results to show per page. Can be any number >= 1.
Default: 15start (ISO Date) - The starting date to show results from. Can be any valid date in ISO Format e.g. yyyy/mm/dd.
Default: start of current monthend (ISO Date) - The ending date to show results until. Can be any valid date in ISO Format e.g. yyyy/mm/dd.
Default: today's dateaffiliateId (number) - A valid ID of an affiliate user to filter for. Only the results of the given affiliate will be shown.
groupByCountry (boolean) - When true the results will be grouped by their country of origin. When false the results will be combined totals from all countries of origin, and country information will not be included in the results.
Default: false{\n \"meta\": {\n \"total\": 24,\n \"perPage\": 15,\n \"currentPage\": 1,\n \"lastPage\": 2,\n \"firstPage\": 1\n },\n \"data\": [\n {\n \"country\": \"Germany\",\n \"affiliateId\": 142,\n \"affiliateUsername\": \"topblog-aff\",\n \"affiliateLabel\": \"Top Blog Network\",\n \"referralLink\": \"https://my-blog.example.com/casino-roundup\",\n \"dynamicVariables\": { \"sub1\": \"blog-roundup\", \"sub2\": \"home-hero\" },\n \"nrc\": 7,\n \"ftd\": 3,\n \"deposits\": 18,\n \"withdrawals\": 4,\n \"totalBonusCost\": 120,\n \"totalGgr\": 2450,\n \"totalNgr\": 1980,\n \"clicks\": 412,\n \"uniqueClicks\": 401,\n \"campaign\": \"spring-2026-de-casino\",\n \"trafficSource\": \"Blog network\",\n \"casinoBonusCost\": 90,\n \"casinoGgr\": 1700,\n \"casinoNgr\": 1400,\n \"sportsBonusCost\": 30,\n \"sportsGgr\": 750,\n \"sportsNgr\": 580\n }\n ]\n}\n\nReturned when the request is missing or carries an invalid Bearer token.
\nReturned when the authenticated user lacks the view-traffic-report permission.
Returned when query parameters fail validation β invalid date, unknown country/brand, or invalid period value.
{\n \"errors\": [\n { \"field\": \"start\", \"message\": \"...\", \"rule\": \"...\" }\n ]\n }\n\nReturns customer data at the individual-customer grain β one row per customer, carrying the affiliate it belongs to, the deal it is attributed to, and its activity figures for the requested period.
\npage (integer) - The page of results that is being requested. Can be any number >= 1.
Default: 1perPage (integer) - How many results to show per page. Can be any number >= 1.
Default: 15start (ISO Date) - The starting date to show results from. Can be any valid date in ISO Format e.g. yyyy/mm/dd.
Default: start of current monthend (ISO Date) - The ending date to show results until. Can be any valid date in ISO Format e.g. yyyy/mm/dd.
Default: today's dateaffiliateId (number) - A valid ID of an affiliate user to filter for. Only the results of the given affiliate will be shown.
{\n \"meta\": {\n \"total\": 142,\n \"perPage\": 15,\n \"currentPage\": 1,\n \"lastPage\": 10,\n \"firstPage\": 1\n },\n \"data\": [\n {\n \"id\": 8421,\n \"ftdDate\": \"2026-05-03\",\n \"externalCustomerId\": \"customer-abc-1\",\n \"customerNickname\": \"playerOne\",\n \"externalCustomerStatus\": \"active\",\n \"registeredAt\": \"2026-05-01T09:14:00.000Z\",\n \"externalAffiliateClickId\": \"ext-click-abc-1\",\n \"dynamicVariables\": { \"sub1\": \"blog-roundup\", \"sub2\": \"home-hero\" },\n \"affiliateId\": 142,\n \"affiliateUsername\": \"topblog-aff\",\n \"affiliateEmail\": \"ops@topblog.example\",\n \"affiliateName\": \"Top Blog Network\",\n \"affiliateLabel\": \"Top Blog Network\",\n \"companyWebsite\": \"https://topblog.example\",\n \"expectedVolumes\": \"100-500\",\n \"trafficSource\": \"Blog network\",\n \"businessModel\": \"CPA\",\n \"paymentType\": \"wire\",\n \"brandName\": \"BrandCool\",\n \"country\": \"Germany\",\n \"campaign\": \"spring-2026-de-casino\",\n \"dealName\": \"DE β Casino CPA β 120\",\n \"ttlCost\": 120,\n \"activeCustomers\": 1,\n \"qualifiedFtds\": 1,\n \"nrc\": 0,\n \"ftd\": 1,\n \"ftdAmount\": 250,\n \"cpaAmount\": 120,\n \"deposits\": 12,\n \"withdrawals\": 4,\n \"totalBets\": 16240,\n \"totalWins\": 15300,\n \"totalBonusCost\": 85,\n \"totalFees\": 40,\n \"totalGgr\": 940,\n \"totalNgr\": 712,\n \"totalRsCost\": 36,\n \"uniqueClicks\": 401\n }\n ]\n}\n\ncustomerNickname carries the value sent in the Nickname column of the registration file β see Import Customers. It is an empty string for customers created without one.
Returned when the request is missing or carries an invalid Bearer token.
\nReturned when the authenticated user lacks the view-customer-report permission.
Returned when query parameters fail validation β invalid date, unknown country/brand, or invalid period value.
{\n \"errors\": [\n { \"field\": \"start\", \"message\": \"...\", \"rule\": \"...\" }\n ]\n }\n\nRetrieve per-affiliate performance and cost for a date range β traffic, player activity, revenue, and the cost each affiliate generated.
\nUse this for the affiliate-level view of a period. For the same traffic broken down by tracking link, use Traffic Report; for the per-customer breakdown, use Customer Report.
\nAll parameters are optional.
\nPaging and sorting
\npage (integer) - The page of results that is being requested. Can be any number >= 1.Default: 1perPage (integer) - How many results to show per page. Can be any number >= 1.Default: 15sortBy (string) - Column key to sort on. A key that is not part of the current result set is ignored.Default: ftdsortOrder (string) - Either asc or desc.Default: descDate range
\nstart (ISO Date) - The starting date to count activity from. Can be any valid date in ISO format e.g. yyyy-mm-dd.Default: start of current monthend (ISO Date) - The ending date to count activity until.Default: today's dateRow grain
\nBy default one row covers one affiliate for the whole range, totalled across every brand, country, campaign and tracking link. The parameters below subdivide that row, and they combine β each one you add multiplies the row count rather than adding to it.
\nperiod (string) - Split each affiliate by time. One of day, week, month, quarter or year. Adds period to every row.groupByCountry (boolean) - Split by the country the activity came from. Adds country.Default: falsegroupByCampaign (boolean) - Split by campaign. Adds campaign.Default: falsegroupByTrackingLink (boolean) - Split by tracking link. Adds linkId and linkTitle.Default: falsegroupByBrand (boolean) - Split by brand. Adds brandName.Default: falseWhich affiliates are listed
\naffiliateId (number) - Return only this affiliate.search (string) - Match on affiliate username or affiliate ID.username (string) - Match on affiliate username.email (string) - Match on affiliate email address.status (array of string) - Any of approved, rejected, waiting.accountType (string) - Either internal or external.manager (array of number) - IDs of the affiliate managers assigned to the affiliate.affiliateRegistrationStart / affiliateRegistrationEnd (ISO Date) - Limit to affiliates who signed up inside this window. Independent of start and end, which continue to govern the activity counted.affiliateFirstTimeActiveStart / affiliateFirstTimeActiveEnd (ISO Date) - Limit to affiliates whose first activity falls inside this window. Also independent of start and end.ignoreNoActivity (boolean) - When true, drop affiliates with no activity in the range. When false they are returned with zeroed figures.Default: falseignoreNoNrcAndFtd (boolean) - When true, keep only rows with at least one registration or first-time depositor.Default: falseignoreRejected (boolean) - When true, drop rejected affiliates.Default: falseWhich activity is counted
\nThese narrow the figures without removing affiliates from the list. An affiliate who sent traffic from three countries still occupies one row when you filter to one of them β that row simply carries only that country's share.
\nbrand (array of number) - Count only activity for these brands. Must be brands the token's account can see.country (number) - Count only activity from this country. Must be a valid country ID.Export
\nexportTo (string) - Either csv or xlsx. Returns a file download instead of JSON.exportColumns (object) - Map of column key to the header label to write. Required alongside exportTo, and decides which columns the file carries.Returns the requested page of rows, plus meta.totals β the same figures recalculated across the entire result rather than the page. Ratio columns such as dpp and ppp are recalculated there rather than summed, so meta.totals will not match a column added up by hand.
The key set varies with the request. Split keys appear only alongside their groupBy parameter, and platforms without the multiproduct add-on return the total keys in place of the casino and sports pairs.
{\n \"meta\": {\n \"total\": 24,\n \"perPage\": 15,\n \"currentPage\": 1,\n \"lastPage\": 2,\n \"firstPage\": 1,\n \"totals\": {\n \"clicks\": 18420,\n \"uniqueClicks\": 17233,\n \"nrc\": 486,\n \"ftd\": 121,\n \"deposits\": 154300,\n \"withdrawals\": 42150,\n \"totalNgr\": 78310,\n \"ttlCost\": 31240\n }\n },\n \"data\": [\n {\n \"affiliateId\": 142,\n \"affiliateUsername\": \"topblog-aff\",\n \"affiliateName\": \"Top Blog Network Ltd\",\n \"affiliateEmail\": \"ops@topblog.example.com\",\n \"affiliateLabel\": \"established\",\n \"kybVerified\": \"Verified\",\n \"internalAccount\": \"External\",\n \"isMasterAffiliate\": \"Disabled\",\n \"assignedToMasterAffiliate\": \"\",\n \"firstManagerUsername\": \"j.novak\",\n \"secondManagerUsername\": \"\",\n \"companyWebsite\": \"https://topblog.example.com\",\n \"trafficSource\": \"Blog network\",\n \"businessModel\": \"Content\",\n \"expectedVolumes\": \"100-500 FTD monthly\",\n \"paymentType\": \"Bank transfer\",\n \"clicks\": 412,\n \"uniqueClicks\": 401,\n \"nrc\": 37,\n \"ftd\": 12,\n \"sameMonthFtd\": 9,\n \"qualifiedFtds\": 7,\n \"ftdAmount\": 1450,\n \"ftdDeposits\": 3120,\n \"multipleDepositsCustomers\": 5,\n \"activeCustomers\": 14,\n \"deposits\": 18400,\n \"withdrawals\": 4260,\n \"totalBets\": 96200,\n \"totalWins\": 88150,\n \"totalBonusCost\": 640,\n \"totalFees\": 310,\n \"totalGgr\": 8050,\n \"totalNgr\": 7100,\n \"totalRsCost\": 2130,\n \"cpaAmount\": 900,\n \"ttlCost\": 3030,\n \"masterCost\": 0,\n \"balance\": 1840,\n \"balanceCorrection\": 0,\n \"dpp\": 1533.33,\n \"wpp\": 355,\n \"ngrpp\": 591.67,\n \"cpp\": 252.5,\n \"rawrpp\": 670.83,\n \"ppp\": 339.17\n }\n ]\n}\n\nReturned when the request is missing or carries an invalid Bearer token.
\nReturned when the authenticated user lacks the view-affiliate-report permission.
Returned when query parameters fail validation β an invalid date, an unknown brand or country, an exportTo outside csv and xlsx, or a period outside the five accepted values.
{\n \"errors\": [\n { \"field\": \"start\", \"message\": \"...\", \"rule\": \"...\" }\n ]\n }\n\nThis document will guide you through the integration of both the Newton Documentation of iGsuite.
\nIn order to use any of the endpoints, first refer to the AUTH documentation to understand how to obtain an API key. The key will then have to be passed with an Authorization: Bearer header.
List every tournament set up on the platform, newest-starting first.
\nThis is the Tournaments tab read as JSON: one row per tournament, with the window it runs in, what it competes on, the budget it commits and the number of winner positions it pays out. Reach for Tournament below when you need one tournament's full setup β the affiliate it runs for, its brand, country, landing page and prize ladder.
page (number, optional): page to return. Defaults to 1.perPage (number, optional): rows per page. Defaults to 15.search (string, optional): matches anywhere in the tournament name, case-insensitively.sortBy (string, optional): name, type, startDate (default), endDate or status. Any other value falls back to startDate.sortOrder (string, optional): asc or desc. Defaults to desc.Sorting by status ranks by lifecycle rather than alphabetically β upcoming, then active, then ended β because status is derived from the dates rather than stored. desc reverses that order.
Archived tournaments are never returned here. Rows are tie-broken by descending id, so the order is total and no row can appear on two pages while another appears on none.
\nA page of tournaments.
\n{\n \"meta\": {\n \"total\": 2,\n \"perPage\": 15,\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"firstPage\": 1,\n \"firstPageUrl\": \"/?page=1\",\n \"lastPageUrl\": \"/?page=1\",\n \"nextPageUrl\": null,\n \"previousPageUrl\": null\n },\n \"data\": [\n {\n \"id\": 41,\n \"name\": \"Autumn Clash\",\n \"type\": \"turnover\",\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-09-30\",\n \"subtitle\": \"Win a trip to Malta\",\n \"affiliateId\": 142,\n \"brandId\": 2,\n \"audience\": \"new\",\n \"campaignId\": 56,\n \"activeTrackingLinkId\": \"a8b3e0bd-c0a6-43ac-a1bf-982ed89274c1\",\n \"budget\": 1500,\n \"maxWinners\": 3,\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"createdAt\": \"2026-07-18T09:24:11.204+00:00\",\n \"updatedAt\": \"2026-08-02T14:51:37.880+00:00\",\n \"status\": \"active\",\n \"archived\": false,\n \"isEditable\": true\n },\n {\n \"id\": 37,\n \"name\": \"Summer Sprint\",\n \"type\": \"winnings\",\n \"startDate\": \"2026-06-01\",\n \"endDate\": \"2026-06-30\",\n \"subtitle\": null,\n \"affiliateId\": 118,\n \"brandId\": 2,\n \"audience\": \"affiliated\",\n \"campaignId\": 49,\n \"activeTrackingLinkId\": \"c41d90fe-7b22-4a5f-8ce0-6d1b3a77e412\",\n \"budget\": 800,\n \"maxWinners\": 2,\n \"terms\": null,\n \"createdAt\": \"2026-05-12T11:02:45.117+00:00\",\n \"updatedAt\": \"2026-05-12T11:02:45.117+00:00\",\n \"status\": \"ended\",\n \"archived\": false,\n \"isEditable\": false\n }\n ]\n}\nField notes:
\ntype β how players are ranked: turnover (what they staked) or winnings (what came back).audience β which players the tournament competes over: new (players who sign up through the tournament's own link) or affiliated (the affiliate's existing players).status β upcoming, active or ended. Derived from the date window rather than stored, so it is always consistent with startDate and endDate; a tournament ending today still counts as active.isEditable β false once the window has closed. Update Tournament refuses an ended tournament, so this is what tells you whether an edit is worth attempting.archived β always false on this list, which never returns retired tournaments.budget and maxWinners β both derived from the prizes on save rather than stated by the caller: the budget is their values summed, and maxWinners is how many there are.campaignId and activeTrackingLinkId β the campaign every opt-in is attributed to, and the exclusive tracking link the tournament is published through. Both are provisioned when the tournament is created and stay behind when it is archived. activeTrackingLinkId doubles as the handle the tournament's public leaderboard is addressed by.startDate and endDate are calendar dates (yyyy-MM-dd); createdAt and updatedAt are ISO 8601 timestamps.Your token is missing, invalid, or has not cleared two-factor verification.
\n{\n \"error\": \"Unauthorized access!\"\n}\nYour account cannot read tournaments.
\n{\n \"error\": \"Unauthorized access\"\n}\nA parameter did not validate β a sortOrder that is neither asc nor desc, or a page / perPage that is not a positive number.
{\n \"errors\": [\n {\n \"message\": \"The selected sortOrder is invalid\",\n \"rule\": \"enum\",\n \"field\": \"sortOrder\"\n }\n ]\n}\nYou are sending too many requests. The limit is 600 requests per minute.
\n","urlObject":{"path":["workspaces","api","tournaments"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3f78d42b-8523-6215-6ad5-ee70d03e9ca3"},{"name":"Tournament","id":"c92874fa-57b9-d356-47d3-f02e3b63822c","request":{"method":"GET","header":[],"url":"/workspaces/api/tournaments/:id","description":"Read one tournament's full setup β everything Create Tournament and Update Tournament take, read back in the same shape.
Four of the fields are not tournament properties at all. The country, landing page and link description were spent on the exclusive tracking link the tournament is published through, and the traffic source on its campaign; they are read back off those two rows. That is also why each can come back null β a tournament whose campaign or link has since been detached has nowhere to read them from.
Path parameters:
\nid (number, required): the tournament's id, as Tournaments returns it.No query parameters and no request body.
\nThe tournament as its edit form fills itself from.
\n{\n \"id\": 41,\n \"name\": \"Autumn Clash\",\n \"subtitle\": \"Win a trip to Malta\",\n \"type\": \"turnover\",\n \"audience\": \"new\",\n \"status\": \"active\",\n \"isEditable\": true,\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-09-30\",\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"affiliate\": {\n \"id\": 142,\n \"username\": \"northstar_media\"\n },\n \"brand\": {\n \"id\": 2,\n \"name\": \"MonteCryptos\"\n },\n \"country\": {\n \"id\": 14,\n \"name\": \"Finland\"\n },\n \"trafficSource\": {\n \"id\": 3,\n \"name\": \"SEO\"\n },\n \"landingPage\": \"https://montecryptos.example.com/autumn-clash\",\n \"linkDescription\": \"Autumn Clash tournament traffic\",\n \"campaignId\": 56,\n \"activeTrackingLinkId\": \"a8b3e0bd-c0a6-43ac-a1bf-982ed89274c1\",\n \"prizes\": [\n {\n \"id\": 88,\n \"tournamentId\": 41,\n \"position\": 1,\n \"rewardType\": \"cash\",\n \"reward\": null,\n \"value\": 1000,\n \"createdAt\": \"2026-07-18T09:24:11.204+00:00\",\n \"updatedAt\": \"2026-07-18T09:24:11.204+00:00\"\n },\n {\n \"id\": 89,\n \"tournamentId\": 41,\n \"position\": 2,\n \"rewardType\": \"free_spins\",\n \"reward\": \"250 spins on Book of Dead\",\n \"value\": 500,\n \"createdAt\": \"2026-07-18T09:24:11.204+00:00\",\n \"updatedAt\": \"2026-07-18T09:24:11.204+00:00\"\n }\n ]\n}\nField notes:
\naffiliate β the affiliate the tournament runs for. Immutable once the tournament exists: moving it to a different affiliate would strand the campaign and tracking link provisioned under the first one, so Update Tournament does not accept the field at all.brand, country, trafficSource β each { id, name }, or null. brand is null once the brand has been archived; the other two are null when the tournament's attribution has been detached.landingPage β where the tournament's tracking link sends a player. null for the same reason as above.campaignId and activeTrackingLinkId β present so you can tell an unset field apart from one with nowhere to write back to. With neither, the country, traffic source and landing page you send on an update still validate and then land nowhere.prizes β the winner positions in position order, one per prize. position is 1-based and contiguous.prizes[].rewardType β cash, bonus_money, free_spins or physical.prizes[].reward and prizes[].value β a currency prize (cash, bonus_money) is fully described by its value and carries a null reward; a described prize (free_spins, physical) carries its description in reward alongside the currency value the operator books it at. Both contribute to the tournament's budget.budget and maxWinners are deliberately absent: both are derived from the prizes, and the form that writes this back recalculates them.Your token is missing, invalid, or has not cleared two-factor verification.
\n{\n \"error\": \"Unauthorized access!\"\n}\nYour account cannot read tournaments.
\n{\n \"error\": \"Unauthorized access\"\n}\nThe id names no tournament you can read. Archived tournaments answer the same as ones that never existed β they are not distinguishable from here.
\n{\n \"message\": \"Row not found\"\n}\nA tournament that exists but belongs to an affiliate outside your reach answers 404 as well, under a different body. Treat both as the same outcome.
\n{\n \"error\": \"User is inaccessible or cannot be found!\"\n}\nYou are sending too many requests. The limit is 600 requests per minute.
\n","urlObject":{"path":["workspaces","api","tournaments",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"c92874fa-57b9-d356-47d3-f02e3b63822c"},{"name":"Create Tournament","id":"56de1a85-3312-3759-665f-11331d325b53","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"affiliateId\": 142,\n \"name\": \"Autumn Clash\",\n \"subtitle\": \"Win a trip to Malta\",\n \"type\": \"turnover\",\n \"audience\": \"new\",\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-09-30\",\n \"brandId\": 2,\n \"countryId\": 14,\n \"trafficSourceId\": 3,\n \"landingPage\": \"https://montecryptos.example.com/autumn-clash\",\n \"linkDescription\": \"Autumn Clash tournament traffic\",\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"prizes\": [\n {\n \"rewardType\": \"cash\",\n \"value\": 1000\n },\n {\n \"rewardType\": \"free_spins\",\n \"reward\": \"250 spins on Book of Dead\",\n \"value\": 500\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/workspaces/api/tournaments","description":"Set up a tournament and the attribution it is measured through.
\nOne call stands up three things in a single transaction: the tournament itself, a campaign for the affiliate, and an exclusive tracking link pointed at your landing page. A tournament without them could never be reported on, so either all of it lands or none of it does.
\nSend the body as JSON with Content-Type: application/json.
{\n \"affiliateId\": 142,\n \"name\": \"Autumn Clash\",\n \"subtitle\": \"Win a trip to Malta\",\n \"type\": \"turnover\",\n \"audience\": \"new\",\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-09-30\",\n \"brandId\": 2,\n \"countryId\": 14,\n \"trafficSourceId\": 3,\n \"landingPage\": \"https://montecryptos.example.com/autumn-clash\",\n \"linkDescription\": \"Autumn Clash tournament traffic\",\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"prizes\": [\n {\n \"rewardType\": \"cash\",\n \"value\": 1000\n },\n {\n \"rewardType\": \"free_spins\",\n \"reward\": \"250 spins on Book of Dead\",\n \"value\": 500\n }\n ]\n}\naffiliateId (number, required): the affiliate the tournament runs for. Must be an affiliate account you can reach. Settled here for good β no later edit can move a tournament to a different affiliate.name (string, required, max 55): one affiliate cannot hold two live tournaments of the same name. An archived tournament releases its name.subtitle (string, optional, max 255): the line under the name on the tournament card.type (string, required): how players are ranked β turnover (what they staked) or winnings (what came back).audience (string, required): which players compete β new (players who sign up through the tournament's own link) or affiliated (the affiliate's existing players).startDate (date, required): cannot be in the past. yyyy-MM-dd is the format to send; ISO 8601 and the common regional spellings are also accepted.endDate (date, required): must fall on a later day than startDate.brandId (number, required): the brand the tournament runs on. Must be one visible to you, and cannot be the Unknown brand.countryId (number, required): the country the tracking link is registered for.trafficSourceId (number, required): the traffic source the campaign is registered under.landingPage (string, required, max 2048): where the tracking link sends a player. The scheme is mandatory β montecryptos.example.com is rejected, https://montecryptos.example.com is not.linkDescription (string, optional, max 255): the tracking link's own description. Falls back to the tournament name when omitted.terms (string, optional, max 5000): the terms shown on the tournament card and its public leaderboard.prizes (array, required, 1 to 25 entries): the winner positions, in the order they are paid. The first entry is position 1.rewardType (string, required): cash, bonus_money, free_spins or physical.reward (string, 1 to 255): what the winner receives, in words. Required for free_spins and physical; ignored and stored as null for cash and bonus_money, which their value already describes in full.value (number, required, greater than 0, at most 1000000000): the currency amount. For a described prize this is the operator's own valuation of it β it feeds the budget but is never published on the leaderboard.budget and maxWinners are not accepted. Both are derived from the prizes: the budget is their values summed, maxWinners is how many there are.
The tournament, with the campaign and exclusive link provisioned alongside it.
\n{\n \"message\": \"Tournament created successfully!\",\n \"data\": {\n \"id\": 41,\n \"name\": \"Autumn Clash\",\n \"type\": \"turnover\",\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-09-30\",\n \"subtitle\": \"Win a trip to Malta\",\n \"affiliateId\": 142,\n \"brandId\": 2,\n \"audience\": \"new\",\n \"campaignId\": 56,\n \"activeTrackingLinkId\": \"a8b3e0bd-c0a6-43ac-a1bf-982ed89274c1\",\n \"budget\": 1500,\n \"maxWinners\": 2,\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"createdAt\": \"2026-07-18T09:24:11.204+00:00\",\n \"updatedAt\": \"2026-07-18T09:24:11.204+00:00\",\n \"status\": \"upcoming\",\n \"archived\": false,\n \"isEditable\": true,\n \"prizes\": [\n {\n \"id\": 88,\n \"tournamentId\": 41,\n \"position\": 1,\n \"rewardType\": \"cash\",\n \"reward\": null,\n \"value\": 1000,\n \"createdAt\": \"2026-07-18T09:24:11.204+00:00\",\n \"updatedAt\": \"2026-07-18T09:24:11.204+00:00\"\n },\n {\n \"id\": 89,\n \"tournamentId\": 41,\n \"position\": 2,\n \"rewardType\": \"free_spins\",\n \"reward\": \"250 spins on Book of Dead\",\n \"value\": 500,\n \"createdAt\": \"2026-07-18T09:24:11.204+00:00\",\n \"updatedAt\": \"2026-07-18T09:24:11.204+00:00\"\n }\n ],\n \"campaign\": {\n \"id\": 56,\n \"name\": \"Tournament: Autumn Clash\",\n \"description\": \"Autumn Clash tournament traffic\",\n \"trafficSourceId\": 3,\n \"affiliateId\": 142,\n \"createdAt\": \"2026-07-18T09:24:11.180+00:00\",\n \"updatedAt\": \"2026-07-18T09:24:11.180+00:00\"\n },\n \"activeTrackingLink\": {\n \"id\": \"a8b3e0bd-c0a6-43ac-a1bf-982ed89274c1\",\n \"createdAt\": \"2026-07-18T09:24:11.192+00:00\",\n \"updatedAt\": \"2026-07-18T09:24:11.192+00:00\",\n \"trackingLinkId\": 3120,\n \"affiliateId\": 142,\n \"campaignId\": 56,\n \"trackingUrl\": \"https://api.example.com/t/a8b3e0bd-c0a6-43ac-a1bf-982ed89274c1\"\n }\n }\n}\nNotes on what was provisioned:
\ncampaign.name β always Tournament: followed by the tournament's name. Where an earlier run of the same name already took it, the new one is counted (Tournament: Autumn Clash (2)) rather than refused: campaigns are never deleted and their names are unique per affiliate, so a second annual cup cannot reuse the first one's campaign name. The campaign keeps this name for life β renaming the tournament later does not chase it.activeTrackingLink.id β the tournament's public handle. It is the token in the opt-in URL, the id its leaderboard is addressed by, and the only thing the embeddable widget needs.activeTrackingLink.trackingUrl β the opt-in link itself, ready to hand out.Your token is missing, invalid, or has not cleared two-factor verification.
\n{\n \"error\": \"Unauthorized access!\"\n}\nYour account cannot create tournaments β or affiliateId names a real, visible account that is not an affiliate, which cannot promote a tournament and so cannot be given one.
{\n \"error\": \"User is not an affiliate\"\n}\naffiliateId names an account outside your reach. Deliberately not told apart from an id that does not exist β a validation error would confirm the account is there.
{\n \"error\": \"User is inaccessible or cannot be found!\"\n}\nOne or more fields failed validation. Every failure is reported, not just the first.
\n{\n \"errors\": [\n {\n \"message\": \"This affiliate already has a tournament with this name\",\n \"rule\": \"tournament.name.unique\",\n \"field\": \"name\"\n },\n {\n \"message\": \"The endDate field must be a date after startDate\",\n \"rule\": \"afterField\",\n \"field\": \"endDate\"\n },\n {\n \"message\": \"The reward field must be defined\",\n \"rule\": \"requiredWhen\",\n \"field\": \"prizes.0.reward\"\n }\n ]\n}\nYou are sending too many requests. The limit is 600 requests per minute.
\n","urlObject":{"path":["workspaces","api","tournaments"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"56de1a85-3312-3759-665f-11331d325b53"},{"name":"Update Tournament","id":"cb4d6a45-569b-c1a0-2eab-d643cf9922b4","request":{"method":"PUT","header":[{"value":"application/json","key":"Content-Type"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Autumn Clash\",\n \"subtitle\": \"Win a trip to Malta\",\n \"type\": \"turnover\",\n \"audience\": \"new\",\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-10-15\",\n \"brandId\": 2,\n \"countryId\": 14,\n \"trafficSourceId\": 3,\n \"landingPage\": \"https://montecryptos.example.com/autumn-clash\",\n \"linkDescription\": \"Autumn Clash tournament traffic\",\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"prizes\": [\n {\n \"rewardType\": \"cash\",\n \"value\": 1200\n },\n {\n \"rewardType\": \"free_spins\",\n \"reward\": \"250 spins on Book of Dead\",\n \"value\": 500\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/workspaces/api/tournaments/:id","description":"Edit a tournament, and the campaign and tracking link it is published through.
\nSend the whole tournament, not a diff. Every field below is required, and an omitted optional field is read as cleared rather than unchanged. Read the tournament with Tournament first and send back what you get, amended.
What a competition is decided on settles as it runs, so the edit narrows the closer a tournament gets to being over β see the 409 responses below, which is where those rules live rather than in validation.
\nSend the body as JSON with Content-Type: application/json.
Path parameters:
\nid (number, required): the tournament's id.{\n \"name\": \"Autumn Clash\",\n \"subtitle\": \"Win a trip to Malta\",\n \"type\": \"turnover\",\n \"audience\": \"new\",\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-10-15\",\n \"brandId\": 2,\n \"countryId\": 14,\n \"trafficSourceId\": 3,\n \"landingPage\": \"https://montecryptos.example.com/autumn-clash\",\n \"linkDescription\": \"Autumn Clash tournament traffic\",\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"prizes\": [\n {\n \"rewardType\": \"cash\",\n \"value\": 1200\n },\n {\n \"rewardType\": \"free_spins\",\n \"reward\": \"250 spins on Book of Dead\",\n \"value\": 500\n }\n ]\n}\nThe fields are exactly those of Create Tournament, with the same types and bounds, minus one:
affiliateId is not accepted. Handing a tournament to a different affiliate would strand the campaign and tracking link provisioned under the first one, so it is immutable by omission β sending it changes nothing.name still has to be free within the affiliate's own tournaments, except that the tournament keeps its own name without that counting as a clash with itself.startDate may be resubmitted as it stands at any time. Moving it is what the rules below govern.prizes replaces the ladder wholesale. Nothing references a prize by id, so the old positions are dropped and the array you send becomes positions 1..n with new ids. Send the full ladder every time, in order.What follows the tournament, and what does not:
\nThe tournament re-read, in the same shape Tournament returns.
{\n \"message\": \"Tournament updated successfully!\",\n \"data\": {\n \"id\": 41,\n \"name\": \"Autumn Clash\",\n \"subtitle\": \"Win a trip to Malta\",\n \"type\": \"turnover\",\n \"audience\": \"new\",\n \"status\": \"active\",\n \"isEditable\": true,\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-10-15\",\n \"terms\": \"Minimum 50 EUR turnover to qualify. Prizes are paid within 14 days of the final standings.\",\n \"affiliate\": {\n \"id\": 142,\n \"username\": \"northstar_media\"\n },\n \"brand\": {\n \"id\": 2,\n \"name\": \"MonteCryptos\"\n },\n \"country\": {\n \"id\": 14,\n \"name\": \"Finland\"\n },\n \"trafficSource\": {\n \"id\": 3,\n \"name\": \"SEO\"\n },\n \"landingPage\": \"https://montecryptos.example.com/autumn-clash\",\n \"linkDescription\": \"Autumn Clash tournament traffic\",\n \"campaignId\": 56,\n \"activeTrackingLinkId\": \"a8b3e0bd-c0a6-43ac-a1bf-982ed89274c1\",\n \"prizes\": [\n {\n \"id\": 104,\n \"tournamentId\": 41,\n \"position\": 1,\n \"rewardType\": \"cash\",\n \"reward\": null,\n \"value\": 1200,\n \"createdAt\": \"2026-08-14T10:05:22.661+00:00\",\n \"updatedAt\": \"2026-08-14T10:05:22.661+00:00\"\n },\n {\n \"id\": 105,\n \"tournamentId\": 41,\n \"position\": 2,\n \"rewardType\": \"free_spins\",\n \"reward\": \"250 spins on Book of Dead\",\n \"value\": 500,\n \"createdAt\": \"2026-08-14T10:05:22.661+00:00\",\n \"updatedAt\": \"2026-08-14T10:05:22.661+00:00\"\n }\n ]\n }\n}\nYour token is missing, invalid, or has not cleared two-factor verification.
\n{\n \"error\": \"Unauthorized access!\"\n}\nYour account cannot update tournaments.
\n{\n \"error\": \"Unauthorized access\"\n}\nThe id names no tournament you can read. Archived tournaments answer the same as ones that never existed.
\n{\n \"message\": \"Row not found\"\n}\nThe edit is refused on the tournament's own terms rather than on the shape of what you sent. Three rules, checked in this order, each answering under its own message:
\nThe window has closed. There is no honest edit to make to a competition that has already been decided. isEditable on the tournament tells you this before you try.
{\n \"error\": \"Ended tournaments cannot be edited.\"\n}\nThe tournament is running and you changed its terms. What it competes on, who it competes between and the day it opened are what the players entered under, so type, audience and startDate are settled once it is active. Resubmitting the values it already holds is not a change and stays allowed β which is what lets you send the whole tournament back rather than a diff.
{\n \"error\": \"Audience, type and start date cannot change while a tournament is active.\"\n}\nThe window was moved into the past. A competition cannot be made to have run when it did not, and one closed retroactively would be decided after the fact. endDate gets no slack at all; startDate is exempt on a running tournament, because the rule above already pins it to the day it really opened.
{\n \"error\": \"A tournament cannot be moved into the past. Pick today or a later date.\"\n}\nOne or more fields failed validation. Same rules and messages as Create Tournament.
{\n \"errors\": [\n {\n \"message\": \"This affiliate already has a tournament with this name\",\n \"rule\": \"tournament.name.unique\",\n \"field\": \"name\"\n }\n ]\n}\nYou are sending too many requests. The limit is 600 requests per minute.
\n","urlObject":{"path":["workspaces","api","tournaments",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"cb4d6a45-569b-c1a0-2eab-d643cf9922b4"},{"name":"Archive Tournament","id":"4af9b966-c7dd-92d2-9c99-4f8bc1d94fa7","request":{"method":"DELETE","header":[],"url":"/workspaces/api/tournaments/:id","description":"Retire a tournament.
\nThe row is kept and marked archived rather than deleted, so everything already attributed to the tournament stays attributed and its history keeps reading correctly. What changes is that it stops being reachable: it leaves the tournament list, it leaves the analysis report, Tournament answers 404 for it, and its public leaderboard answers 404 to the widget. Its name becomes free for a new tournament under the same affiliate.
\n\nβ οΈ There is no un-archive over the API. Archive a tournament only when you mean it.
\n
The campaign and the exclusive tracking link are deliberately left behind. Campaigns cannot be deleted through the API, and the link outlives the tournament that provisioned it β retiring either is a separate, manual decision.
\nPath parameters:
\nid (number, required): the tournament's id.No query parameters and no request body.
\nThe tournament is archived. Nothing is returned beyond the confirmation.
\n{\n \"message\": \"Tournament archived successfully!\"\n}\nArchiving an already-archived tournament is not possible β it answers 404, since an archived tournament is unreachable by id.
\nYour token is missing, invalid, or has not cleared two-factor verification.
\n{\n \"error\": \"Unauthorized access!\"\n}\nYour account cannot archive tournaments.
\n{\n \"error\": \"Unauthorized access\"\n}\nThe id names no tournament you can read β one that never existed, or one already archived.
\n{\n \"message\": \"Row not found\"\n}\nYou are sending too many requests. The limit is 600 requests per minute.
\n","urlObject":{"path":["workspaces","api","tournaments",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"4af9b966-c7dd-92d2-9c99-4f8bc1d94fa7"},{"name":"Tournament Analysis Report","id":"da0feaf9-dc5e-5420-c0ca-1bc5464312d5","request":{"method":"GET","header":[],"url":"/workspaces/api/tournaments/analysis?start=2026-08-01&end=2026-09-30","description":"What each tournament acquired over a period β one row per tournament, with the clicks, registrations, depositors, revenue and cost attributed to it.
\nTwo rules decide what you get back, and they are not the same rule:
\nstart and end, even where the tournament ran longer.\n\nβ οΈ This report measures acquisition, and only acquisition. Every customer-grained figure keys off the stamp on that customer's registration click, so it counts the players a tournament brought in. A tournament whose
\naudienceisaffiliatedβ one competing over players the affiliate already had β therefore reads zeros here and deliberately disagrees with its own leaderboard, which is ranking those existing players just fine. ReadTournament Standingsfor who is winning; read this for what the campaign recruited.
Archived tournaments never appear.
\nAll parameters are optional.
\nstart (date): start of the period. Defaults to the first day of the current month.end (date): end of the period. Defaults to now. Send dates as yyyy-MM-dd.lifecycle (string): narrow to a slice of the lifecycle β live-upcoming (anything not yet ended), completed (ended only), or all. Omitted means no lifecycle predicate.tournamentId (number array): restrict to specific tournaments. Repeat the parameter β tournamentId[]=41&tournamentId[]=37.affiliateId (number): restrict to one affiliate's tournaments.brand (number array): restrict to brands, by id. Must be brands visible to you.page (number): page to return. Defaults to 1.perPage (number): rows per page. Defaults to 15.sortBy (string): any column name from the row below β for example uniqueClicks, ftd, totalNgr, tournamentName. Defaults to tournamentStartDate. A name that is not a column of this report is ignored rather than rejected, and you get the default order.sortOrder (string): asc or desc. Defaults to desc.exportTo (string): csv or xlsx. See Exporting below.exportColumns (object): required alongside exportTo.Send exportTo and exportColumns together and the response stops being JSON: you get the file itself, streamed, with Content-Disposition: attachment; filename=report.csv (or .xlsx). The export ignores page and perPage and streams every row the filters match.
exportColumns maps a field name to the heading you want above it, and its order is the column order:
exportColumns[tournamentName]=Tournament Campaign\nexportColumns[tournamentStartDate]=Start Date\nexportColumns[uniqueClicks]=Unique Clicks\nexportColumns[ftd]=FTD\nA field the report did not produce is dropped from the file rather than emitted empty.
\nA page of tournaments, with the same measures totalled across the whole filtered set in meta.totals.
{\n \"meta\": {\n \"total\": 2,\n \"perPage\": 15,\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"firstPage\": 1,\n \"totals\": {\n \"cpaAmount\": 900,\n \"ftd\": 46,\n \"multipleDepositsCustomers\": 19,\n \"nrc\": 312,\n \"roi\": 203.06,\n \"totalGgr\": 14820.5,\n \"totalNgr\": 11260.75,\n \"totalRsCost\": 2815.19,\n \"ttlCost\": 3715.19,\n \"uniqueClicks\": 8941\n }\n },\n \"data\": [\n {\n \"affiliateId\": 142,\n \"affiliateUsername\": \"northstar_media\",\n \"cpaAmount\": 600,\n \"ftd\": 31,\n \"multipleDepositsCustomers\": 14,\n \"nrc\": 208,\n \"roi\": 206.29,\n \"totalGgr\": 10120.4,\n \"totalNgr\": 7845.2,\n \"totalRsCost\": 1961.3,\n \"tournamentEndDate\": \"2026-09-30\",\n \"tournamentId\": 41,\n \"tournamentName\": \"Autumn Clash\",\n \"tournamentStartDate\": \"2026-08-01\",\n \"tournamentStatus\": \"active\",\n \"ttlCost\": 2561.3,\n \"uniqueClicks\": 6204\n },\n {\n \"affiliateId\": 118,\n \"affiliateUsername\": \"reeljump\",\n \"cpaAmount\": 300,\n \"ftd\": 15,\n \"multipleDepositsCustomers\": 5,\n \"nrc\": 104,\n \"roi\": 195.72,\n \"totalGgr\": 4700.1,\n \"totalNgr\": 3415.55,\n \"totalRsCost\": 853.89,\n \"tournamentEndDate\": \"2026-08-31\",\n \"tournamentId\": 44,\n \"tournamentName\": \"Late Summer Cup\",\n \"tournamentStartDate\": \"2026-08-10\",\n \"tournamentStatus\": \"ended\",\n \"ttlCost\": 1153.89,\n \"uniqueClicks\": 2737\n }\n ]\n}\nField notes:
\ntournamentId, tournamentName β the tournament the row is about. tournamentName is the tournament's own name, not its campaign's.tournamentStatus β upcoming, active or ended, read off the database's clock so it always agrees with the dates beside it.tournamentStartDate, tournamentEndDate β the tournament's own window, yyyy-MM-dd. Not the period you asked for, which the measures are clamped to instead.affiliateId, affiliateUsername β the affiliate the tournament runs for.uniqueClicks β clicks on the tournament's link, deduplicated.nrc β newly registered customers acquired through it.ftd β of those, the ones who made a first deposit.multipleDepositsCustomers β of those, the ones who deposited more than once.totalGgr, totalNgr β gross and net gaming revenue from the customers it acquired.totalRsCost β the revenue-share the affiliate earned on them; cpaAmount β the CPA earned; ttlCost β what the tournament cost in total, which is what roi is measured against.roi β (totalNgr / ttlCost - 1) Γ 100, already a percentage, and 0 when ttlCost is 0.meta.totals β the same measures over every row the filters match, not just this page. It carries no tournament identity, since a grand total is no single tournament.Your token is missing, invalid, or has not cleared two-factor verification.
\n{\n \"error\": \"Unauthorized access!\"\n}\nYour account cannot read the tournament analysis. Reading tournaments and reading their analysis are separate β holding the first does not imply the second.
\n{\n \"error\": \"Unauthorized access\"\n}\nA parameter did not validate β an unrecognised lifecycle, an exportTo that is neither csv nor xlsx, a brand id you cannot see, or a malformed date.
{\n \"errors\": [\n {\n \"message\": \"The selected lifecycle is invalid\",\n \"rule\": \"enum\",\n \"field\": \"lifecycle\"\n }\n ]\n}\nYou are sending too many requests. The limit is 600 requests per minute.
\n","urlObject":{"path":["workspaces","api","tournaments","analysis"],"host":[""],"query":[{"key":"start","value":"2026-08-01"},{"key":"end","value":"2026-09-30"}],"variable":[]}},"response":[],"_postman_id":"da0feaf9-dc5e-5420-c0ca-1bc5464312d5"},{"name":"Tournament Standings","id":"b1bd50e6-c264-af00-0a27-25956f15617b","request":{"method":"GET","header":[],"url":"/workspaces/api/tournaments/:id/standings","description":"Read a tournament's current standings β the prize ladder with whoever is holding each rung, and when the board was last rebuilt.
\nThis is what you decide payouts from. Every prize the tournament offers has a row whether or not anyone has qualified for it yet, in position order, so the board reads as a full ladder rather than as a list of current winners β an unclaimed prize is a prize still open, not a row to leave out.
\nAddressed by the tournament's id, not by the public handle the embeddable widget uses. A tournament that was never published through a link of its own has no handle and is still a row in the table, so this reaches it either way.
\n\n\nThis read is never cached. The public leaderboard is served from a one-minute cache; this one is not, because a copy up to a minute old served under a
\ncomputedAtsaying otherwise is the one wrong answer to give someone deciding what to pay out.
The board and the analysis report can disagree, and both are right. Tournament Analysis Report counts only the players a tournament acquired; the board ranks everyone competing in it. A tournament whose audience is affiliated β competing over the affiliate's existing players β reads zeros in that report while showing a full ladder here.
Path parameters:
\nid (number, required): the tournament's id, as Tournaments or Tournament Analysis Report returns it.No query parameters and no request body.
\nThe ladder, and its age.
\n{\n \"computedAt\": \"2026-08-11T06:00:04.512+00:00\",\n \"rows\": [\n {\n \"position\": 1,\n \"rewardType\": \"cash\",\n \"reward\": null,\n \"value\": 1000,\n \"player\": \"joh*****\",\n \"points\": 184320\n },\n {\n \"position\": 2,\n \"rewardType\": \"cash\",\n \"reward\": null,\n \"value\": 500,\n \"player\": \"mar*****\",\n \"points\": 96140\n },\n {\n \"position\": 3,\n \"rewardType\": \"physical\",\n \"reward\": \"Weekend for two in Malta\",\n \"value\": null,\n \"player\": null,\n \"points\": null\n }\n ]\n}\nField notes:
\ncomputedAt β when the board was last rebuilt, as an ISO 8601 timestamp. null until a board has been built at all, which is indistinguishable from one nobody has qualified for. The figures move when the operator imports and at no other time, so this is the only honest freshness marker there is β a board is rebuilt on the import schedule, not on the clock.rows[].position β the prize's rung, 1-based and contiguous.rows[].rewardType β cash, bonus_money, free_spins or physical.rows[].reward and rows[].value β a currency prize (cash, bonus_money) publishes its amount in value and leaves reward null; a described prize (free_spins, physical) publishes its description in reward and leaves value null. The currency figure behind a described prize is the operator's own valuation of it, and it is withheld here as it is on the public board.rows[].player and rows[].points β both null on a position nobody has qualified for yet, which is how an open prize reads. points is the tournament's ranking measure: turnover staked or winnings returned, depending on the tournament's type.player is masked β at most the first three characters of the nickname, then a fixed run of five asterisks. A short nickname gives up fewer characters and a very short one gives up none at all (*****), so the visible prefix can never amount to most of a name. The masking is applied in the stored column rather than on the way out, so no read path holds the full nickname: it is free text an operator imported and may well be an email address. The asterisk run is a fixed length, so the mask does not publish how long the nickname is.Your token is missing, invalid, or has not cleared two-factor verification.
\n{\n \"error\": \"Unauthorized access!\"\n}\nYour account cannot read the tournament analysis.
\n{\n \"error\": \"Unauthorized access\"\n}\nThe id names no tournament you can read. One answer covers all of it β never existed, archived since, or belonging to an affiliate or a brand outside your reach. They are deliberately not told apart: a reader who could distinguish them could sort the tournaments they are kept away from out of a list of ids.
\n{\n \"error\": \"Tournament not found\"\n}\nYou are sending too many requests. The limit is 600 requests per minute.
\n","urlObject":{"path":["workspaces","api","tournaments",":id","standings"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"b1bd50e6-c264-af00-0a27-25956f15617b"}],"id":"1e458c8f-dcc7-4920-9181-55971e4d6393","description":"Endpoints for setting up and running tournaments, and for reading how they performed β the campaigns themselves, and the analysis behind them: what each tournament acquired over a period, the month-to-date figures above it, and the live prize ladder with whoever is currently holding each position.
\n","_postman_id":"1e458c8f-dcc7-4920-9181-55971e4d6393"}],"event":[{"listen":"prerequest","script":{"id":"316db919-6cd1-40b8-a1b9-f0dcda29e55d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"de58fcd6-941b-4f80-987e-4118ba0f3f0c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"","type":"default"}]}