Get profile action history
Description
Retrieves a single profile action history.
Request URL
Method: POST
https://example.com/api/v1.1/subscribers/history_get
Request parameters
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
| format | string | "json" | No | Response data format. By default – json |
| list_id | Int | 20 | Yes | Database ID |
| xxh | string | "0eb51aefd919f90a" | No, of you use matching for search | xx hash profile ID |
| matching | string | "email" "email_profile" "email_sub" "phone" "phone_sub" "profile_id" "push_sub" "custom" "custom_sub" "email_phone" "email_phone_sub" | No, of you use xxh for search | Profile matching mode By default — email For each type of matching, certain fields must be passed in the request body. Learn more about these fields here. |
| date_from | string | "2016-11-25" | No | Time period start YYYY-MM-DD |
| date_to | string | "2016-11-29" | No | Time period end YYYY-MM-DD |
Request example
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"list_id": 20,
"xxh": "0eb51aefd919f90a"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<list_id>20</list_id>
<xxh>0eb51aefd919f90a</xxh>
</xml>
Response example
- JSON
- XML
{
"data": [
{
"xxh": "9202595093f237d4",
"profile_id": "66f66973096b3b454bbbccec",
"email": "example@example.com",
"list_id": 66,
"action": "send",
"count": 1,
"datetime": "2024-09-27T15:52:57.004Z",
"message_id": 5,
"campaign_id": 137,
"event_id": "66f6aaa9da00a9db1c0b2683",
"smid": "uBAhiRBRQhARg7y489hr5F2b2aXMJaztFS7vM7DE1NGJhZWM5",
"campaign_name": "New astral mailing",
"message_name": "testing",
"subscription": {
"resource_id": 5,
"resource_name": "res1",
"channel": "email",
"email": "sub1@yandex.ru",
"priority": 0,
"status": "subscribed",
"custom_fields": {
"_device_type": "other"
},
"cats": []
},
"channel": "email",
"subscriptions": [
{
"resource_id": 5,
"resource_name": "res1",
"channel": "email",
"email": "sub1@yandex.ru",
"priority": 0,
"status": "subscribed",
"custom_fields": {
"_device_type": "other"
},
"cats": []
},
{
"resource_id": 5,
"resource_name": "res1",
"channel": "email",
"email": "sub2@yandex.ru",
"priority": 0,
"status": "subscribed",
"custom_fields": {
"_device_type": "mob"
},
"cats": []
}
]
}
],
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data>
<item>
<xxh>9202595093f237d4</xxh>
<profile_id>66f66973096b3b454bbbccec</profile_id>
<email>example@example.ru</email>
<list_id>66</list_id>
<action>send</action>
<count>1</count>
<datetime>2024-09-27T15:52:57.004Z</datetime>
<message_id>5</message_id>
<campaign_id>137</campaign_id>
<event_id>66f6aaa9da00a9db1c0b2683</event_id>
<smid>uBAhiRBRQhARg7y489hr5F2b2aXMJaztFS7vM7DE1NGJhZWM5</smid>
<campaign_name>New astral mailing</campaign_name>
<message_name>testing</message_name>
<subscription>
<resource_id>5</resource_id>
<resource_name>res1</resource_name>
<channel>email</channel>
<email>sub1@yandex.ru</email>
<priority>0</priority>
<status>subscribed</status>
<custom_fields>
<_device_type>other</_device_type>
</custom_fields>
<cats/>
</subscription>
<channel>email</channel>
<subscriptions>
<subscription>
<resource_id>5</resource_id>
<resource_name>res1</resource_name>
<channel>email</channel>
<email>sub1@yandex.ru</email>
<priority>0</priority>
<status>subscribed</status>
<custom_fields>
<_device_type>other</_device_type>
</custom_fields>
<cats/>
</subscription>
<subscription>
<resource_id>5</resource_id>
<resource_name>res1</resource_name>
<channel>email</channel>
<email>sub2@yandex.ru</email>
<priority>0</priority>
<status>subscribed</status>
<custom_fields>
<_device_type>mob</_device_type>
</custom_fields>
<cats/>
</subscription>
</subscriptions>
</item>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | string | An array of received data regarding events in the profile history |
| data.xxh | string | Profile xxhash ID |
| data.profile_id | string | Profile ID |
| data.email | string | Profile email |
| data.list_id (db_id) | int | Database ID |
| data.action | string | Profile action (More details) |
| data.count | int | Number of actions taken in this second |
| data.datetime | string | Date and time of the action in RFC 3339 (ISO 8601) format |
| data.message_id | int | Message template ID Returns 0 if the action does not involve using a template. |
| data.campaign_id | int | Mailing ID Returns 0 if the action does not involve using a mailing. |
| data.event_id | string | Event ID |
| data.smid | string | Unique identifier of the send within the mailing Returns an empty string if the action does not involve sending a message. |
| data.campaign_name | string | Name of the mailing Returns an empty string if the action does not involve using a mailing. |
| data.message_name | string | Name of the message template Returns an empty string if the action does not involve using a template. |
| data.subscription | string | Object containing information about the subscription under which the sending was performed |
| data.channel | string | Communication channel in which the event was recorded. Returns an empty string if the channel is not involved. |
| data.subscriptions | array of objects | All subscriptions of the profile. For CSV format, it will be represented as a JSON string. |
| error | int | Error code |
| error_text | string | Error message |
Profile history events (action)
| Email channel events | |
| send | Email sent |
| deliv | Email delivered |
| undeliv | Email not delivered |
| open | Email opened |
| read | Email read. The message was opened by the user for 8 seconds or more |
| click | Email clicked. Registered when the user clicks a link in the email. Each link click is registered as a separate click event, so if a profile clicks on two different links in the same email, two click events will be recorded. |
| confirm | Click on the subscription confirmation link in the email (confirm-link) |
| subscribe_email | Subscribed to the Email channel of the resource |
| unsubscribe_email | Unsubscribed from the Email channel of the resource |
| reply | Received a reply to the Email |
| complain | Received a Complain status |
| hbounce | Received a Hard Bounce status |
| SMS channel events | |
| send_sms | SMS message sent to the gateway for subscriber delivery |
| deliv_sms | SMS message delivered |
| undeliv_sms | SMS message not delivered |
| click_sms | Non-unique click on the link in the SMS message |
| subscribe_sms | Subscribed to the SMS channel of the resource |
| unsubscribe_sms | Unsubscribed from the SMS channel of the resource |
| Push channel events | |
| send_push | Push sent |
| deliv_push | Push delivered |
| open_push | Non-unique opening of the push message |
| click_push | Click on the Push message |
| undeliv_push | Push message not delivered |
| subscribe_push | Subscribed to the Push channel of the resource |
| unsubscribe_push | Unsubscribed from the Push channel of the resource |
| Telegram Bot Channel Events | |
| telegram_bot_send | Telegram bot event: Telegram bot sent |
| telegram_bot_deliv | Telegram bot event: Telegram bot delivered |
| telegram_bot_undeliv | Telegram bot event: Telegram bot not delivered |
| telegram_bot_click | Telegram bot event: Telegram bot click |
| telegram_bot_subscribe | Telegram bot event: Telegram bot subscription |
| WhatsApp* channel events | |
| whatsapp_send | Message sent for delivery to the WhatsApp* chat |
| whatsapp_deliv | Message delivered to the WhatsApp* chat |
| whatsapp_undeliv | Message not delivered to the WhatsApp* chat |
| whatsapp_click | Non-unique click on the link in the WhatsApp* chat message |
| whatsapp_read | Message read by the user |
| whatsapp_subscribe | WhatsApp* channel event: WhatsApp* subscription |
| Viber channel events | |
| viber_send | Message sent for delivery to the Viber chat |
| viber_deliv | Message delivered to the recipient |
| viber_undeliv | Message not delivered, rejected by Viber or Devino.Online |
| viber_click | Click on the link in the message. If the recipient clicks on the same link several times, each click event is recorded. |
| viber_read | Message read by the user |
| viber_subscribe | Viber channel event: Viber subscription |
| Events for all channels | |
| offence | Message not sent due to sending policy restrictions |
| suppress | Message not sent by the mailing because the profile is on the stop list |
| Subscriber Profile Import Events | |
| import_manual | Profile created manually |
| import_api | Profile created by API import |
| import_file | Profile created by import from a file |
| import_form | Profile created by import from a form |
| import_push | Profile created as a result of push import |
| import_popup | Profile created by import via popup |
| Unsubscribe Events | |
| unsub_api | Subscriber unsubscribed from emails via API |
| unsub_manual | Unsubscribed manually (global profile status changed to "Unsubscribed") |
| Pixel events | |
| pixel_open | Goal achieved |
| Promo codes events | |
| promocode_attach | Promo code attached |
| promocode_detach | Promo code detached |
| promocode_activate | Promo code activated |
| Segment events | |
| segs_add | Entered a static segment |
| segs_remove | Exited a static segment |
| Profile Relationship Events | |
| rel_attach | Profile receives a connection with another profile |
| rel_detach | Profile loses a connection with another profile |
| rel_strengthen | Weight of the connection between profiles increases |
| Form Events | |
| form_load | Form loaded |
| form_page_show | Form page loaded |
| form_post | Form filled and submitted |
| form_abandon | Form abandoned. The profile loads the form page and does not close it for an hour, without submitting the form. |
| form_bounce | Error in filling out the form (attempted re-filling, technical issues, etc.) |
*The Meta organization, which owns Instagram, Facebook and WhatsApp products, has been declared as extremist and banned in Russia.