---
title: "Get contacts activity"
method: GET
path: "/api/v2/contacts/activity"
tags: ["Behavior tracking"]
---

# Get contacts activity

`GET /api/v2/contacts/activity`

## Request

- Base URL: `https://yespo.io` (the document declares no server; this is the origin it was published from)
- URL: `https://yespo.io/api/v2/contacts/activity`
- Auth: HTTP basic

The method returns the contact activity on subscriptions.

## Query parameters

- `dateFrom` string, required
- `dateTo` string, required
- `email` string
- `sms` string
- `webPushToken` string
- `mobPushToken` string
- `telegramToken` string
- `messageTag` string
- `activityStatus` 'DELIVERED' | 'UNDELIVERED' | 'READ' | 'UNSUBSCRIBED' | 'CLICKED' | 'SPAM'
- `offset` string
- `maxrows` integer

## Response `200`

- ContactActivity[]
  - `iid` string: ID of the sent message.
  - `externalRequestId` string: External request ID.
  - `contactId` integer: Contact ID.
  - `externalCustomerId` string: External contact ID.
  - `email` string: Contact's email address.
  - `webPushToken` string: Web push token.
  - `mobPushToken` string: Mob push token.
  - `sms` string: Contact's phone number.
  - `mediaType` 'email' | 'sms' | 'viber' | 'mobilepush' | 'webpush' | 'appinbox' | 'widget' | 'inapp' | 'telegrambot': Media type: Email, SMS, Viber.
  - `activityStatus` string: 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
  - `messageId` integer: Message ID.
  - `messageInstanceId` integer: Message instance ID.
  - `messageName` string: Message name.
  - `messageTag` string: Email message label.
  - `activityDateTime` string: Activity date and time.
  - `statusDescription` string: 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.
  - `viewMessageLink` string: Contains a link to the message. For emails only.
  - `clickEventLink` string: Contains the link clicked by the contact.
  - `subscriptions` string[]: Subscription category keys
  - `offset` string: Contains the bias result. Used to continue the previous search.
  - `messageLanguageCode` string: Message language code.
  - `sourceEventKey` string: Source event key.
  - `sourceEventTypeKey` string: Source event type key.
  - `workflowBlockId` string: Workflow block ID.
  - `workflowId` integer: Workflow ID.
  - `workflowInstanceId` string: The ID of a particular workflow launch.
  - `broadcastId` integer: Broadcast ID.
  - `from` string: Sender
  - `telegramToken` string: TelegramToken
  - `osType` string: Device operation system type. Possible values: Desktop, Mobile.
  - `osName` string: Device operation system name. Example values: Windows NT, iOS, Mac OS.
  - `imid` integer: Immediate message id.
  - `smsParts` integer: Number of SMS message parts. Returned for SMS activities only.

---

[API](https://skmtc.dev/yespo/apis/yespo-api.md) · [All operations](https://skmtc.dev/yespo/apis/yespo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yespo/apis/yespo-api/revisions/b662f92b6c40?raw)