API Integration Checklist

To ensure a seamless integration and maximize your campaign performance, please review this checklist. It covers the essential best practices, parameter mappings, and feature utilizations required to

Feature/ Parameter	Checklist Question	Recommendation / Action	Explanation
API Refresh/Pull Rate	Are you fetching data at the optimal interval?	Pull data every 5 to 10 minutes.	We recommend 5 to 10 minutes refresh rate due to capReached parameter refresh to avoid invalid clicks and also if there are any bids changes you can also detect it earlier to avoid discrepancy.
status query parameter	Are you filtering out paused campaigns?	Pass the status=active query parameter in API requests.	To help filtering out paused campaigns
capReached parameter (in API response)	Are you filtering out capped campaigns?	Use capReached = true in the response to filter.	To help filtering out capped campaigns to avoid invalid user clicks
Campaign ID	Which identifier are you using to identify a specific campaign?	Map to campaignId in the API response	campaignId is generated from our internal system so it would be our recommendation to identify a specifc campaign [correspond to campaign_id macros in postback]
Event ID	Which identifier are you using to identify a specific event?	Map to appEventId in the API response	appEventId is generated from our internal system so it would be our recommendation to identify a specific event within a campaign [correspond to app_event_id macros in postback]
rankingScore parameter (in API response)	Are you using our optimization metric?	Use this 30-day average CPI/CPA to maximize campaign exposure.	the rankingScore parameter is the average CPI/CPA of a campaign in last 30 days, you can use this data to maximum and optimize your campaign exposure.
Media Source	Are you passing media source data?	If available, please do send the media source data through Source ID parameter in the tracking (ClickURL) macros [can be setup in Solutions dashboard]	Media Source data is the data on where you acquired the users. We will use this in our systems for user base segmentation and allow us to provide media source specific rewards. Can be in string or integer form (etc 5880, or Applovin)
GAID / IDFA	Are you passing the device ID (GAID/IDFA) to us through the tracking macros?	If available, please do send the media source data through Google Ad ID and IDFA parameter in the tracking (ClickURL) macros [can be setup in Solutions dashboard]	We also use device id to detect fraudulent user activity, if possible, we would also recommend you to send the device id to us.
maxTime parameter (in API response)	Do you need to check on the maximum allowed time for a event?	You may utilize the maxTime parameter in our API response where it is the maximum allowed time for a user to complete an event after install.	Available in API response.
changeId (only in V2 Publisher Active Campaign API)	Do you need an indicator every time when the payout changes within a campaign?	changeId - parameter that changes everytime we made updates on the payout the specific campaign (etc changing from 1 to 2)	Integer. You may ingest this parameter on your end to know when some changes in payout occurred in a specific campaign.

---

Tracking URL (s) Handling

Your system must be able to handle both types of tracking URLs returned in the API response. Set up your tracking macros to dynamically replace {YOURINPUT} with actual data:

1. Tyrads URL (click.tyrads.com) [as shown in Solutions dashboard] https://click.tyrads.com/?s2s=0&campaignId=5577&publisherId=627&sub2={YOURINPUT}&sub3={YOURINPUT}&sub4={YOURINPUT}&sub5={YOURINPUT}&publisherUserId={YOURINPUT}&sourceId={YOURINPUT}&googleAdId={YOURINPUT}&idfa={YOURINPUT}&oaid={YOURINPUT}&publisherClickId={YOURINPUT}

   Note: Campaigns using click.tyrads.com URL will not include the everflowEventId parameter in payoutEvents, and the offerId (from Everflow) will return as null within the API response.

2. Everflow URL (ltv-mob.com ) https://www.ltv-mob.com/257J8KR/2N13CLN5/?sub1={YOURINPUT}&sub2={YOURINPUT}&sub3={YOURINPUT}&sub4={YOURINPUT}&sub5={YOURINPUT}&user_id={YOURINPUT}&source_id={YOURINPUT}&google_aid={YOURINPUT}&idfa={YOURINPUT}