Overview

The Charity Engine Distribution Partner API enables our advertising partners to Advertising partners integrate directly with Charity Engine through a combination of installation flow callbacks and API requests to track campaign activity and performance. Through this API, partners can manage campaigns, track installs, and access performance metrics Callbacks allow us to notify you when events take place or milestones are reached for a given install, while our API allows review of campaign and affiliate performance in real time.

Access and Setup

To begin using the API, partners must obtain credentials and campaign identifiers:

The first step is to obtain campaign identifiers and optional API credentials:

• Campaign ID: Uniquely identifies each advertising campaign.
• API Key (optional): Used API Key: Required for authentication on all API calls.
• Campaign ID: Uniquely identifies each advertising campaign.

Please contact usto set up your API key and define your campaign IDs prior to integration.

Integration

Review the Charity Engine Distribution Partner API documentation.

and exchange any callback requirements for integration, and also to receive your API key for reporting.

If callbacks are required, please provide the URL format and any instructions for proper usage. For example:

https://yourdomain.com/callback?campaign={campaignID}&click={clickID}&event={eventID}&status=complete

Define any mapping required of data to the URL parameters so it is clear what values to return via the callback. Also describe the circumstance by which the callback should be made (e.g. installation is complete, still active after 30 days, etc.). While we can assume that clickID here would correspond to the same identifier used to launch the install initially, it is best to define it all explicitly.

Integration

Once campaigns and callback details are establishedOnce your campaign and API key are configured, initiate tracking links in the format below:

...

• clickID: Unique identifier for each user click.
• affiliateID (optional): Identifies specific traffic sources.

Tracking and Reporting

Review the Charity Engine Distribution Partner API documentation.

Charity Engine now supports detailed reporting of click and affiliate activity via the /installs/ids endpoint:. This reporting can be used as an alternative to callback integration, or as a supplement to ensure accuracy.

To retrieve Retrieve all click IDs for a campaign:

https://www.charityengine.com/api/v1/installs/ids?campaign={campaignID}&auth={APIkey}

Filter To further filter those click IDs by affiliate:

https://www.charityengine.com/api/v1/installs/ids?campaign={campaignID}&source_id={affiliateID}&auth={APIkey}

...