10.3 Reports via API
Provide Reports via API to Affiliate/IBs or internal employees, allowing them to access performance data directly in their own systems without logging into the platform.
API access for Affiliate/IB
To enable API access for Affiliate/IBs you must first whitelist API, give permission and generate the API Token, following the next steps
Navigate into Affiliate Management > Manage
Select the affiliate or click to the arrow icon on the rightmost of the row. Click on the Open Affiliate Page
Navigate into API tab.
Select on API Token Permission dropdown the Get leads report option. Then, Save Permissions
Whitelisted IPs to secure API access. Define the From and To fields to define a range of IP addresses or add a single IP. Then, click Add to save the IP(s) to the whitelist.
To allow the full API range, set the minimum (0.0.0.0) and maximum (255.255.255.255). Only set full range if you really want open access.
Additionally, find previously added IP ranges in the list with a trashcan icon to delete unwanted entries.
API Key gives you the unique token for API integration.
To generate the key, click the Plus button and copy the token API value
To renew the key, click the Extend Expiry Date button to update its validity.
The API Key is sensitive information. Share it only with the corresponding affiliate/IB and never expose it publicly.
Once is API Key is generated, you can customize the Report to share with the Affiliate/IB.
API access for Employees
To enable API access for employees you must first whitelist API, give permission and generate the API Token, following the next steps
Navigate into Integration > API Token Management
Select the desired Employee to create the API token
Select on API Token Permission dropdown the Get leads report option. Then, Save Permissions
Whitelisted IPs to secure API access. Define the From and To fields to define a range of IP addresses or add a single IP. Then, click Add to save the IP(s) to the whitelist.
To allow the full API range, set the minimum (0.0.0.0) and maximum (255.255.255.255). Only set full range if you really want open access.
Additionally, find previously added IP ranges in the list with a trashcan icon to delete unwanted entries.
API Key gives you the unique token for API integration.
To generate the key, click the Plus button and copy the token API value
To renew the key, click the Extend Expiry Date button to update its validity.
The API Key is sensitive information. Share it only with the corresponding employee and never expose it publicly.
Once API Token is generated for employee or affiliate/IB
Log in as the employee or affiliate/IB to have their permissions and preview exactly how the report will appear for them.
One way: Use the top search bar for looking for the desired affiliate/IB.
Another way: Navigate into Affiliate Management > Manage and select the desired affiliate/IB
Select the log in as the affiliate/IB
Navigate by the left Sidebar Menu and click on the Reports or Performance Report. Select the desired report you want to create the API
Customize Reports using the Columns button at top of the report.
Click on the API button on the top right corner, to display API information
Check the cURL mode to select the system format
Copy Clipboard to share the API Body Report to the desired Affiliate/IB
Last updated