Sign in

v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB
Behavior tracking

Get contacts activity

The method returns the contact activity on subscriptions.

get/api/v2/contacts/activity

Query parameters

dateFromstring required

Initial date and time of the period you want to get the contact activity for

dateTostring required

Final date and time of the period you want to get the contact activity for

emailstring

Email address

smsstring

Contact's phone number

webPushTokenstring

Web Push token

mobPushTokenstring

Mob Push token

telegramTokenstring

Telegram token

messageTagstring

Message tag

activityStatus'DELIVERED' | 'UNDELIVERED' | 'READ' | 'UNSUBSCRIBED' | 'CLICKED' | 'SPAM'

Activity status (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM)

offsetstring

Last found contact activity offset in previous search results. It is used to continue search

maxrowsinteger

Max number of activity entries in response

Response

iidstring

ID of the sent message.

externalRequestIdstring

External request ID.

contactIdinteger

Contact ID.

externalCustomerIdstring

External contact ID.

emailstring

Contact's email address.

webPushTokenstring

Web push token.

mobPushTokenstring

Mob push token.

smsstring

Contact's phone number.

mediaType'email' | 'sms' | 'viber' | 'mobilepush' | 'webpush' | 'appinbox' | 'widget' | 'inapp' | 'telegrambot'

Media type: Email, SMS, Viber.

activityStatusstring

Activity status<br/><br/> <b>DELIVERED</b> - message delivered<br/> <b>UNDELIVERED</b> - message not delivered<br/> <b>READ</b> - message read<br/> <b>UNSUBSCRIBED</b> - contact unsubscribed from mailing<br/> <b>SUBSCRIPTION_CHANGED</b> - contact changed subscription categories<br/> <b>CLICKED</b> - contact followed the links in the message<br/> <b>SPAM</b> - contact complained about spam

messageIdinteger

Message ID.

messageInstanceIdinteger

Message instance ID.

messageNamestring

Message name.

messageTagstring

Email message label.

activityDateTimestring

Activity date and time.

statusDescriptionstring

This field is returned only if the status is UNDELIVERED,<br/> Contains the cause of the delivery failure.<br/> This may be a response from the recipient's server, a system's response about inability to send the message, etc.

viewMessageLinkstring

Contains a link to the message. For emails only.

clickEventLinkstring

Contains the link clicked by the contact.

subscriptionsstring[]

Subscription category keys

offsetstring

Contains the bias result. Used to continue the previous search.

messageLanguageCodestring

Message language code.

sourceEventKeystring

Source event key.

sourceEventTypeKeystring

Source event type key.

workflowBlockIdstring

Workflow block ID.

workflowIdinteger

Workflow ID.

workflowInstanceIdstring

The ID of a particular workflow launch.

broadcastIdinteger

Broadcast ID.

fromstring

Sender

telegramTokenstring

TelegramToken

osTypestring

Device operation system type. Possible values: Desktop, Mobile.

osNamestring

Device operation system name. Example values: Windows NT, iOS, Mac OS.

imidinteger

Immediate message id.