Email campaigns (legacy)
Get email campaign activities
Returns a page of activity events for the campaign (30 per page, page is 0-based). RE_REPLY and (internally) OPENED are excluded. Filter with type (single event) or types (comma-separated list), by contactId or versionId, and search (tokens on firstName/lastName/email) or query (exact email). New integrations should use the multichannel /advanced campaign endpoints instead.
get/emails/campaigns/{campaignId}/activities
Request
- Base URL: https://api.emelia.io
- URL: https://api.emelia.io/emails/campaigns/{campaignId}/activities
- Auth: API key in header Authorization
Path parameters
campaignIdstring required
Mongo ObjectId of the campaign.
Query parameters
contactIdstring
versionIdstring
type'SENT' | 'FIRST_OPEN' | 'OPENED' | 'CLICKED' | 'REPLIED' | 'BOUNCED' | 'UNSUBSCRIBED'
typesstring
Comma-separated list of events.
pagestring
0-based page index. 30 items per page.
querystring
Exact email match.
searchstring
Token search on firstName/lastName/email.
Response
Activities (note: envelope is { activities }, no success flag).
Changes
No recorded changes to this operation across all 1 revision of this API.