Skip to content

Commit 184c58f

Browse files
authored
feat(docs): add customer_statistics_updated push in Agent API (#1598)
1 parent ec2d82f commit 184c58f

File tree

3 files changed

+71
-10
lines changed

3 files changed

+71
-10
lines changed

src/pages/messaging/agent-chat-api/changelog/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ The developer preview version provides a preview of the upcoming changes to the
5959
- There are new pushes:
6060
- [**ticket_created**](/messaging/agent-chat-api/rtm-pushes/#ticket_created)
6161
- [**ticket_deleted**](/messaging/agent-chat-api/rtm-pushes/#ticket_deleted)
62+
- [**customer_statistics_updated**](/messaging/agent-chat-api/rtm-pushes/#customer_statistics_updated)
6263

6364
### Status
6465

src/pages/messaging/agent-chat-api/rtm-pushes/index.mdx

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Here's what you need to know about **pushes**:
3535
| **Events** | [`incoming_event`](#incoming_event) [`event_deleted`](#event_deleted) [`event_updated`](#event_updated) [`incoming_rich_message_postback`](#incoming_rich_message_postback) |
3636
| **Properties** | [`chat_properties_updated`](#chat_properties_updated) [`chat_properties_deleted`](#chat_properties_deleted) [`thread_properties_updated`](#thread_properties_updated) [`thread_properties_deleted`](#thread_properties_deleted) [`event_properties_updated`](#event_properties_updated) [`event_properties_deleted`](#event_properties_deleted) |
3737
| **Thread tags** | [`thread_tagged`](#thread_tagged) [`thread_untagged`](#thread_untagged) |
38-
| **Customers** | [`incoming_customers`](#incoming_customers) [`incoming_customer`](#incoming_customer) [`customer_updated`](#customer_updated) [`customer_page_updated`](#customer_page_updated) [`customer_banned`](#customer_banned) [`customer_transferred`](#customer_transferred) [`customer_left`](#customer_left) [`subscribed_customers_totals_updated`](#subscribed_customers_totals_updated) [`ticket_created`](#ticket_created) [`ticket_deleted`](#ticket_deleted) |
38+
| **Customers** | [`incoming_customers`](#incoming_customers) [`incoming_customer`](#incoming_customer) [`customer_updated`](#customer_updated) [`customer_page_updated`](#customer_page_updated) [`customer_statistics_updated`](#customer_statistics_updated) [`customer_banned`](#customer_banned) [`customer_transferred`](#customer_transferred) [`customer_left`](#customer_left) [`subscribed_customers_totals_updated`](#subscribed_customers_totals_updated) [`ticket_created`](#ticket_created) [`ticket_deleted`](#ticket_deleted) |
3939
| **Status** | [`routing_status_set`](#routing_status_set) [`agent_disconnected`](#agent_disconnected) |
4040
| **Configuration** | [`agent_created`](#agent_created) [`agent_approved`](#agent_approved) [`agent_updated`](#agent_updated) [`agent_suspended`](#agent_suspended) [`agent_unsuspended`](#agent_unsuspended) [`agent_deleted`](#agent_deleted) [`auto_accesses_updated`](#auto_accesses_updated) [`bot_created`](#bot_created) [`bot_updated`](#bot_updated) [`bot_deleted`](#bot_deleted) [`group_created`](#group_created) [`group_updated`](#group_updated) [`group_deleted`](#group_deleted) [`tag_created`](#tag_created) [`tag_deleted`](#tag_deleted) [`tag_updated`](#tag_updated) [`groups_status_updated`](#groups_status_updated) [`license_properties_updated`](#license_properties_updated) [`group_properties_updated`](#group_properties_updated) |
4141
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) [`incoming_sneak_peek`](#incoming_sneak_peek) [`incoming_thinking_indicator`](#incoming_thinking_indicator) [`incoming_typing_indicator`](#incoming_typing_indicator) [`incoming_multicast`](#incoming_multicast) [`chat_unfollowed`](#chat_unfollowed) [`queue_positions_updated`](#queue_positions_updated) [`customer_unfollowed`](#customer-unfollowed) [`thread_summary_set`](#thread-summary-set) |
@@ -628,7 +628,7 @@ Informs that customer's data changed. The push payload contains the updated fiel
628628

629629
### `customer_page_updated`
630630

631-
Informs that a Customer moved to another page of the website.
631+
Informs that a customer moved to another page of the website.
632632

633633
<CodeResponse title={'Sample push payload'}>
634634

@@ -644,9 +644,38 @@ Informs that a Customer moved to another page of the website.
644644

645645
</CodeResponse>
646646

647+
### `customer_statistics_updated`
648+
649+
Informs that the customer's statistics were updated.
650+
651+
<CodeResponse title={'Sample push payload'}>
652+
653+
```json
654+
{
655+
"customer_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
656+
"statistics": {
657+
"chats_count": 9,
658+
"threads_count": 13,
659+
"visits_count": 14,
660+
"page_views_count": 15,
661+
"greetings_accepted_count": 0,
662+
"greetings_converted_count": 0,
663+
"tickets_count": 6,
664+
"tickets_inbox_count": 6,
665+
"tickets_archive_count": 0,
666+
"tickets_spam_count": 0,
667+
"tickets_trash_count": 0,
668+
"orders_count": 15,
669+
"last_visit_started_at": "2025-10-17T13:37:15Z"
670+
}
671+
}
672+
```
673+
674+
</CodeResponse>
675+
647676
### `customer_banned`
648677

649-
Informs that a Customer was banned for a specified number of days.
678+
Informs that a customer was banned for a specified number of days.
650679

651680
<CodeResponse title={'Sample push payload'}>
652681

@@ -681,7 +710,7 @@ Informs that a customer is no longer available to the agent.
681710

682711
### `customer_left`
683712

684-
Informs that a Customer left the tracked website.
713+
Informs that a customer left the tracked website.
685714

686715
<CodeResponse title={'Sample push payload'}>
687716

@@ -719,6 +748,7 @@ Informs that a ticket was created for a tracked customer.
719748
{
720749
"customer_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
721750
"ticket_id": "0c04cb99-817a-4935-9d62-137c89a74388",
751+
"silo": "inbox",
722752
"created_at": "2019-12-05T07:27:08.820000Z"
723753
}
724754
```
@@ -1300,7 +1330,7 @@ Informs that one of the chat users (an Agent or a Bot Agent) is currently typing
13001330

13011331
### `incoming_sneak_peek`
13021332

1303-
Informs about the message a Customer is currently typing. The push payload contains the sneak peek object.
1333+
Informs that a customer is currently typing a message. The push payload contains the sneak peek object.
13041334

13051335
<CodeResponse title={'Sample push payload'}>
13061336

src/pages/messaging/agent-chat-api/v3.7/rtm-pushes/index.mdx

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Here's what you need to know about **pushes**:
3535
| **Events** | [`incoming_event`](#incoming_event) [`event_deleted`](#event_deleted) [`event_updated`](#event_updated) [`incoming_rich_message_postback`](#incoming_rich_message_postback) |
3636
| **Properties** | [`chat_properties_updated`](#chat_properties_updated) [`chat_properties_deleted`](#chat_properties_deleted) [`thread_properties_updated`](#thread_properties_updated) [`thread_properties_deleted`](#thread_properties_deleted) [`event_properties_updated`](#event_properties_updated) [`event_properties_deleted`](#event_properties_deleted) |
3737
| **Thread tags** | [`thread_tagged`](#thread_tagged) [`thread_untagged`](#thread_untagged) |
38-
| **Customers** | [`incoming_customers`](#incoming_customers) [`incoming_customer`](#incoming_customer) [`customer_updated`](#customer_updated) [`customer_page_updated`](#customer_page_updated) [`customer_banned`](#customer_banned) [`customer_transferred`](#customer_transferred) [`customer_left`](#customer_left) [`subscribed_customers_totals_updated`](#subscribed_customers_totals_updated) [`ticket_created`](#ticket_created) [`ticket_deleted`](#ticket_deleted) |
38+
| **Customers** | [`incoming_customers`](#incoming_customers) [`incoming_customer`](#incoming_customer) [`customer_updated`](#customer_updated) [`customer_page_updated`](#customer_page_updated) [`customer_statistics_updated`](#customer_statistics_updated) [`customer_banned`](#customer_banned) [`customer_transferred`](#customer_transferred) [`customer_left`](#customer_left) [`subscribed_customers_totals_updated`](#subscribed_customers_totals_updated) [`ticket_created`](#ticket_created) [`ticket_deleted`](#ticket_deleted) |
3939
| **Status** | [`routing_status_set`](#routing_status_set) [`agent_disconnected`](#agent_disconnected) |
4040
| **Configuration** | [`agent_created`](#agent_created) [`agent_approved`](#agent_approved) [`agent_updated`](#agent_updated) [`agent_suspended`](#agent_suspended) [`agent_unsuspended`](#agent_unsuspended) [`agent_deleted`](#agent_deleted) [`auto_accesses_updated`](#auto_accesses_updated) [`bot_created`](#bot_created) [`bot_updated`](#bot_updated) [`bot_deleted`](#bot_deleted) [`canned_response_created`](#canned_response_created) [`canned_response_updated`](#canned_response_updated) [`canned_response_deleted`](#canned_response_deleted) [`group_created`](#group_created) [`group_updated`](#group_updated) [`group_deleted`](#group_deleted) [`tag_created`](#tag_created) [`tag_deleted`](#tag_deleted) [`tag_updated`](#tag_updated) [`groups_status_updated`](#groups_status_updated) [`license_properties_updated`](#license_properties_updated) [`group_properties_updated`](#group_properties_updated) |
4141
| **Other** | [`events_marked_as_seen`](#events_marked_as_seen) [`incoming_sneak_peek`](#incoming_sneak_peek) [`incoming_thinking_indicator`](#incoming_thinking_indicator) [`incoming_typing_indicator`](#incoming_typing_indicator) [`incoming_multicast`](#incoming_multicast) [`chat_unfollowed`](#chat_unfollowed) [`queue_positions_updated`](#queue_positions_updated) [`customer_unfollowed`](#customer-unfollowed) [`thread_summary_set`](#thread-summary-set) |
@@ -628,7 +628,7 @@ Informs that customer's data changed. The push payload contains the updated fiel
628628

629629
### `customer_page_updated`
630630

631-
Informs that a Customer moved to another page of the website.
631+
Informs that a customer moved to another page of the website.
632632

633633
<CodeResponse title={'Sample push payload'}>
634634

@@ -644,9 +644,38 @@ Informs that a Customer moved to another page of the website.
644644

645645
</CodeResponse>
646646

647+
### `customer_statistics_updated`
648+
649+
Informs that the customer's statistics were updated.
650+
651+
<CodeResponse title={'Sample push payload'}>
652+
653+
```json
654+
{
655+
"customer_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
656+
"statistics": {
657+
"chats_count": 9,
658+
"threads_count": 13,
659+
"visits_count": 14,
660+
"page_views_count": 15,
661+
"greetings_accepted_count": 0,
662+
"greetings_converted_count": 0,
663+
"tickets_count": 6,
664+
"tickets_inbox_count": 6,
665+
"tickets_archive_count": 0,
666+
"tickets_spam_count": 0,
667+
"tickets_trash_count": 0,
668+
"orders_count": 15,
669+
"last_visit_started_at": "2025-10-17T13:37:15Z"
670+
}
671+
}
672+
```
673+
674+
</CodeResponse>
675+
647676
### `customer_banned`
648677

649-
Informs that a Customer was banned for a specified number of days.
678+
Informs that a customer was banned for a specified number of days.
650679

651680
<CodeResponse title={'Sample push payload'}>
652681

@@ -681,7 +710,7 @@ Informs that a customer is no longer available to the agent.
681710

682711
### `customer_left`
683712

684-
Informs that a Customer left the tracked website.
713+
Informs that a customer left the tracked website.
685714

686715
<CodeResponse title={'Sample push payload'}>
687716

@@ -719,6 +748,7 @@ Informs that a ticket was created for a tracked customer.
719748
{
720749
"customer_id": "b7eff798-f8df-4364-8059-649c35c9ed0c",
721750
"ticket_id": "0c04cb99-817a-4935-9d62-137c89a74388",
751+
"silo": "inbox",
722752
"created_at": "2019-12-05T07:27:08.820000Z"
723753
}
724754
```
@@ -1352,7 +1382,7 @@ Informs that one of the chat users (an Agent or a Bot Agent) is currently typing
13521382

13531383
### `incoming_sneak_peek`
13541384

1355-
Informs about the message a Customer is currently typing. The push payload contains the sneak peek object.
1385+
Informs that a customer is currently typing a message. The push payload contains the sneak peek object.
13561386

13571387
<CodeResponse title={'Sample push payload'}>
13581388

0 commit comments

Comments
 (0)