Report data model
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the campaign report |
start_at | string (date-time) | No | Start time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | End time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
campaign_id | string | No | Associated campaign ID |
list_id | string | No | Associated list ID |
emails_sent | number | No | Total emails sent |
abuse_reports | number | No | Number of abuse reports |
unsubscribed | number | No | Number of unsubscribes |
sent_at | string (date-time) | No | Send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
hard_bounces | number | No | Hard bounce count |
soft_bounces | number | No | Soft bounce count |
syntax_errors | number | No | Syntax error count |
forwards_count | number | No | Forward count |
forwards_opens | number | No | Forwards opened |
opens_total | number | No | Total opens |
unique_opens | number | No | Unique opens |
open_rate | number | No | Open rate (decimal) |
last_open_at | string (date-time) | No | Last open timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
clicks_total | number | No | Total clicks |
unique_clicks | number | No | Unique clicks |
unique_subscriber_clicks | number | No | Unique subscriber clicks |
click_rate | number | No | Click rate (decimal) |
last_click_at | string (date-time) | No | Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
links | MarketingReportLink[] | No | URL-specific click data |
links[].url | string | No | The URL |
links[].total_clicks | number | No | Total clicks on this link |
links[].click_percentage | number | No | Percentage of total clicks |
links[].unique_clicks | number | No | Unique clicks on this link |
links[].unique_click_percentage | number | No | Percentage of unique clicks |
links[].last_click_at | string (date-time) | No | Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
human_opens_total | number | No | Total opens excluding automated/bot/proxy (e.g. Apple Mail Privacy Protection) opens |
human_unique_opens | number | No | Unique opens excluding automated/bot/proxy opens |
human_open_rate | number | No | Open rate (decimal) excluding automated/bot/proxy opens |
metadata | MarketingMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?