Attribution Report
The Attribution API is currently a beta feature. For early access, please reach out to support@heypoplar.com
The Attribution Report endpoint enables you to generate an Attribution Report for up to 6 months of data. The resulting report will be delivered in batches to a webhook URL of your choosing (see below).
Generate attribution report
POST
https://api.heypoplar.com/v1/reports/attribution
This endpoint allows you to generate an attribution report from a specified reporting window that will be delivered through a webhook.
Request Body
start_date*
string
YYYY-MM-DD (ISO8601) formatted date for the start of the reporting window.
campaign_id
string
The ID of the campaign for the report.
If not set, the report will contain all campaigns
end_date*
string
YYYY-MM-DD (ISO8601) for the end of the reporting window.
Must be no more than 180 days after start_date
Webhook Setup
This page will only appear if the Attribution API has been enabled for your account
To setup your Attribution API webhook, navigate to Integrations > Attribution Report and click the button to create a new webhook. From here, enter a webhook destination URL of your choosing. To verify the webhook has been setup correctly, use the "Send Test" link and ensure that a 200
response is returned.
Webhook Payload
When the report has finished generating, it will be sent through the webhook that was previously setup.
campaign_id
The ID of the campaign for the report (if provided)
start_date
The starting date for the report window
end_date
The end date for the report window
batch_index
The index of the current batch of results
total_batches
The total number of batches contained in the report
attribution_data
Example Payload
This sample response shows one complete set of data for a "match." Payloads will hold up to 100 matches per batch. The keys found in attribution_data
are the same keys used in Download Raw Matches on the transactions page https://app.heypoplar.com/transaction.
Last updated