Campaign tracking

List campaign activities

Activities of the campaign, newest first, 30 per page. page is ZERO based; an empty array means you reached the end. Results are cached for up to 10 minutes. Filters: contactId wins over search, which wins over query. When query is an exact email, the type filters are ignored.

get/advanced/campaigns/{campaignId}/activities

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/advanced/campaigns/{campaignId}/activities
  • Auth: API key in header Authorization

Path parameters

campaignIdstring required

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1

Identifier of a multichannel campaign (24 hexadecimal characters), as returned by POST /advanced/campaigns or GET /advanced/campaigns.

Query parameters

pagestring
type'VISITED' | 'INVITED' | 'ACCEPTED' | 'MESSAGE_SENT' | 'INMAIL_SENT' | 'LINKEDIN_REPLIED' | 'MAIL_REPLIED' | 'RE_REPLY_EMAIL' | 'RE_REPLY_LINKEDIN' | 'FOLLOWED' | 'LIKED' | 'SENT' | 'BOUNCED' | 'RE_REPLY' | 'OPENED' | 'UNSUBSCRIBED' | 'CLICKED' | 'WHATSAPP_MESSAGE_SENT' | 'WHATSAPP_REPLIED' | 'TASK_COMPLETED' | 'TASK_FAILED' | 'FAILED_ACTION' | 'EXCLUDED'

Activity event of a multichannel campaign. SENT, OPENED, CLICKED, BOUNCED, UNSUBSCRIBED, MAIL_REPLIED are email events; VISITED, INVITED, ACCEPTED, MESSAGE_SENT, INMAIL_SENT, LIKED, FOLLOWED, LINKEDIN_REPLIED are LinkedIn events. RE_REPLY and FAILED_ACTION are never returned by the activities route.

Single event filter. MESSAGE_SENT also returns INMAIL_SENT.

typesstring

Comma separated events, for example MAIL_REPLIED,LINKEDIN_REPLIED. Wins over type.

contactIdstring

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1
versionIdstring
searchstring

Search contacts by name, email or LinkedIn URL.

querystring

Legacy filter: an exact email address.

Response

Success.

Example response

{
  "activities": [
    {
      "_id": "6650f1a2b839d80011c5a0f1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.