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
{
"list_id": 20,
"token": "abcdefghijklmnqrstuvwxyz",
"xxh": "0eb51aefd919f90a"
}
Response example
{
"data": [
{
"action": "click",
"count": 1,
"datetime": "2017-04-05T07:48:44Z",
"email": "email@mail.roo",
"list_id": 20,
"message_id": 184,
"xxh": "0eb51aefd919f90a"
},
{
"action": "open",
"count": 1,
"datetime": "2017-04-05T07:48:44Z",
"email": "email@mail.roo",
"list_id": 20,
"message_id": 184,
"xxh": "a81879594020ac07"
},
{
"action": "send",
"count": 1,
"datetime": "2017-04-05T07:48:41Z",
"email": "email@mail.roo",
"list_id": 20,
"message_id": 184,
"xxh": "0eb51aefd919f90a"
}
],
"error": 0,
"error_text": "Successful operation"
}
Response parameters
| Parameter | Type | Description |
|---|---|---|
| error | int | Error code |
| error_text | string | Error text |
| action | string | Profile action |
| count | int | Number of actions |
| datetime | string | Date and time of the action |
| string | Subscription email address | |
| db_id (list_id) | int | Profiles database ID |
| message_id | int | Message template ID |
| xxh | string | profile xxhash id |
| campaign_id | int | Campaign ID |
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 campaign 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.) |