\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: number,\n createdAt: string, // ISO 8601 timestamp of when the token was created\n lastUsedAt: string | null // ISO 8601 timestamp of the most recent successful API call using this token, or null if never used\n}\n\nThe user does not currently have an active api token.
\n","urlObject":{"path":["workspaces","api","api-token"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f3834732-cdb9-389a-9c01-c840a901754a"},{"name":"Generate Api Token","id":"425abad6-a42f-c6cc-70f0-1136a059f171","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"/workspaces/api/api-token","description":"Generates 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: number,\n createdAt: string, // ISO 8601 timestamp of creation\n lastUsedAt: string | null, // null on creation\n token: string // plaintext token β keep secret, store immediately, NOT retrievable later\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.
Short-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.
\nThe 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.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 400 Bad Request 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.
Filter 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 \"debug\": \"ForbiddenException: 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.
\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
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 \"Brand\": \"BrandName\",\n \"Affiliate\": \"AffiliateUsername\",\n // ...rest of the keys mentioned in File Information (or different, if configured otherwise)\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: string\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: string\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 /**\n * Response message\n */\n message: string,\n /**\n * Import details.\n */\n details: {\n /**\n * Number of rows which were found to be valid and successfully imported.\n */\n imported: number // number of imported rows\n /**\n * Number of rows which were found to have errors and were skipped from import.\n */\n skipped: number\n }\n /**\n * An array of errors that were found in the imported data.\n */\n errors: Array<{\n /**\n * The column that contains the invalid values.\n */\n column: string\n /**\n * Additional context and information as to why the data in the row is invalid.\n */\n message?: string\n /**\n * The row numbers that are invalid. They are indexed from 1.\n * Header row will not be counted for CSV and XLSX files.\n */\n rows: number[]\n /**\n * String representation of the invalid values. They are ordered in their\n * order of appearance, meaning that they match the rows at the same index.\n */\n values: string[]\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 /**\n * Actual error message.\n */\n error: string,\n /**\n * Information for error debugging.\n */\n debug: {\n /**\n * Name of the column that lead to the error.\n */\n column: string,\n /**\n * The reason for the error.\n */\n reason: string,\n }\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: string\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: string\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 \"debug\": \"FileImportBatchValidationException: Invalid Customer values: 1005\",\n \"column\": \"Customer\",\n \"reason\": \"Invalid 'Customer' values 1005.\"\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: string\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: string\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 /**\n * Response message\n */\n message: string,\n /**\n * Import details.\n */\n details: {\n /**\n * Number of rows which were found to be valid and successfully imported.\n */\n imported: number // number of imported rows\n /**\n * Number of rows which were found to have errors and were skipped from import.\n */\n skipped: number\n }\n /**\n * An array of errors that were found in the imported data.\n */\n errors: Array<{\n /**\n * The column that contains the invalid values.\n */\n column: string\n /**\n * Additional context and information as to why the data in the row is invalid.\n */\n message?: string\n /**\n * The row numbers that are invalid. They are indexed from 1.\n * Header row will not be counted for CSV and XLSX files.\n */\n rows: number[]\n /**\n * String representation of the invalid values. They are ordered in their\n * order of appearance, meaning that they match the rows at the same index.\n */\n values: string[]\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 /**\n * Actual error message.\n */\n error: string,\n /**\n * Information for error debugging.\n */\n debug: {\n /**\n * Name of the column that lead to the error.\n */\n column: string,\n /**\n * The reason for the error.\n */\n reason: string,\n }\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":"This endpoint retrieves information about a customer based on an encoded token associated with a tracking link click.
\nQuery Parameters:
\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}\n\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\": Number,\n \"perPage\": Number,\n \"currentPage\": Number,\n \"lastPage\": Number,\n \"firstPage\": Number\n },\n \"data\": [\n {\n \"country\": String,\n \"affiliateId\": Number,\n \"affiliateUsername\": String,\n \"affiliateLabel\": String,\n \"referralLink\": String,\n \"dynamicVariables\": Record<String, String> | null,\n \"nrc\": Number,\n \"ftd\": Number,\n \"deposits\": Number,\n \"withdrawals\": Number,\n \"totalBonusCost\": Number,\n \"totalGgr\": Number,\n \"totalNgr\": Number,\n \"clicks\": Number,\n \"uniqueClicks\": Number,\n \"campaign\": String,\n \"trafficSource\": String,\n // Only for Multi Product platforms\n \"casinoBonusCost\": Number, \n \"casinoGgr\": Number,\n \"casinoNgr\": Number,\n \"sportsBonusCost\": Number,\n \"sportsGgr\": Number,\n \"sportsNgr\": Number\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\nThis API endpoint is used to obtain customer 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.
{\n \"meta\": {\n \"total\": Number,\n \"perPage\": Number,\n \"currentPage\": Number,\n \"lastPage\": Number,\n \"firstPage\": Number\n },\n \"data\": [\n {\n \"id\": Number,\n \"ftdDate\": String,\n \"externalCustomerId\": String,\n \"externalCustomerStatus\": String,\n \"registeredAt\": String,\n \"externalAffiliateClickId\": String,\n \"dynamicVariables\": Record<string, string> | null,\n \"affiliateId\": Number,\n \"affiliateUsername\": String,\n \"affiliateEmail\": String,\n \"affiliateName\": String,\n \"affiliateLabel\": String,\n \"companyWebsite\": String,\n \"expectedVolumes\": String,\n \"trafficSource\": String,\n \"businessModel\": String,\n \"paymentType\": String,\n \"brandName\": String,\n \"country\": String,\n \"campaign\": String,\n \"dealName\": String,\n \"ttlCost\": Number,\n \"activeCustomers\": Number,\n \"qualifiedFtds\": Number,\n \"nrc\": Number,\n \"ftd\": Number,\n \"ftdAmount\": Number,\n \"cpaAmount\": Number,\n \"deposits\": Number,\n \"withdrawals\": Number,\n \"totalBets\": Number,\n \"totalWins\": Number,\n \"totalBonusCost\": Number,\n \"totalFees\": Number,\n \"totalGgr\": Number,\n \"totalNgr\": Number,\n \"totalRsCost\": Number,\n \"uniqueClicks\": Number\n }\n ]\n}\n\nReturned 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\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.