Webgains (Platform API)



To find out more about the Webgains API check their docs out here.

Set up

To set up the Webgains (Platform API) connector in your app all you will need is an Access Token. You can follow the steps here to generate one.


Backfillβœ…Custom for transaction reports and all time for Program Memberships
Incrementalβœ…Only for the Transaction Report
API reliability🟒Reliable

Reports detail

⬇️ ReportπŸ”‘ Incremental keyπŸ”‘ Primary keyπŸ“„ Link to API endpoint
Transaction ReportDATEIDGet Transaction Report
Transaction Report Single CampaignDATEIDGet Transaction Report
Transaction Report (custom periods)N/AIDGet Transaction Report
Transaction Report Single Campaign (custom periods)N/AIDGet Transaction Report
Program MembershipsN/AIDGet All Program Memberships


Incremental logic for Transaction Report

The API currently does not allow to filter transactions via the LAST_UPDATED field, so incremental logic relies on the DATE field of transactions.

This means some data might be missed on incremental (append) runs for transactions where the LAST_UPDATED is much later than the DATE field value. To avoid missing data, you can periodically do backfill runs and do reconciliations in the data warehouse.



Transaction reports runs can generate duplicates, so you will need to de-duplicate in a Transform.