Skip to content

Commit 9605d46

Browse files
feat(docs): add new report endpoints (#1520)
1 parent edf50b2 commit 9605d46

File tree

7 files changed

+424
-55
lines changed

7 files changed

+424
-55
lines changed

payloads/data-reporting/v3.6/reports-api/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ export { default as forms } from "./responses/chats/forms.json";
1313
export { default as responseTime } from "./responses/chats/responseTime.json";
1414
export { default as firstResponseTime } from "./responses/chats/firstResponseTime.json";
1515
export { default as chatUsage } from "./responses/tags/chatUsage.json";
16+
export { default as uniqueVisitors } from "./responses/customers/uniqueVisitors.json";
17+
export { default as queuedVisitors } from "./responses/chats/queuedVisitors.json";
18+
export { default as queuedVisitorsLeft } from "./responses/chats/queuedVisitorsLeft.json";
19+
export { default as groups } from "./responses/chats/groups.json";
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "groups-report",
3+
"total": 29,
4+
"records": {
5+
"2024-08-20": {
6+
"0": 1,
7+
"2": 1
8+
},
9+
"2024-08-21": {
10+
"0": 20,
11+
"1": 2
12+
},
13+
"2024-08-22": {
14+
"0": 1,
15+
"1": 2,
16+
"3": 1,
17+
"4": 1
18+
}
19+
}
20+
}
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"name": "queued-visitors-report",
3+
"total": 15,
4+
"records": {
5+
"2024-10-01": {
6+
"left_queue": {
7+
"count": 13,
8+
"min": 0,
9+
"max": 100,
10+
"avg": 20.5384615384615383
11+
},
12+
"queued": {
13+
"count": 13,
14+
"min": 0,
15+
"max": 20,
16+
"avg": 2.5384615384615383
17+
}
18+
},
19+
"2024-10-02": {
20+
"left_queue": {
21+
"count": 2,
22+
"min": 0,
23+
"max": 3,
24+
"avg": 0.21311475409836064
25+
},
26+
"queued": {
27+
"count": 2,
28+
"min": 1,
29+
"max": 10,
30+
"avg": 5.523131672597864
31+
}
32+
},
33+
"2024-10-03": {}
34+
}
35+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"name": "queued-visitors-left-report",
3+
"total": 2,
4+
"summary": {
5+
"left_without_details": 2,
6+
"total_pages": 1
7+
},
8+
"records": {
9+
"SK0P33W2ZJ": {
10+
"visitor": {
11+
"id": "0f864f86-556e-46a9-848e-d2d5fe0a8fe0",
12+
"ip": "169.50.11.126"
13+
},
14+
"queue": {
15+
"duration": 123,
16+
"group": 0,
17+
"start_date": "2024-10-01T20:47:07Z"
18+
}
19+
},
20+
"SK0Q3SGMBN": {
21+
"visitor": {
22+
"id": "04e8c9b6-8dc3-4067-a749-0ef983f99e6d",
23+
"ip": "169.50.11.126"
24+
},
25+
"queue": {
26+
"duration": 21,
27+
"group": 6291,
28+
"start_date": "2024-10-02T18:56:47Z"
29+
}
30+
}
31+
}
32+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"name": "visitors-report",
3+
"summary": {
4+
"unique_visitors": 4,
5+
"page_views": 23
6+
}
7+
}

src/pages/data-reporting/changelog/index.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ The developer preview version provides a preview of the upcoming changes to the
2121

2222
## [v3.6] - Developer preview
2323

24-
No changes yet.
24+
- There's a new method, [**Unique Visitors**](/data-reporting/reports-api/v3.6/reports/stats/unique_visitors), which returns the total number of page views and unique visitors during the specified period.
25+
- There's a new method, [**Group Chats Count**](/data-reporting/reports-api/v3.6/#groups), which returns the total number of chats handled by each group during the specified period.
26+
- There's a new method, [**Queued Visitors**](/data-reporting/reports-api/v3.6/#queued_customers), which returns the number of customers who waited in the queue during the specified period.
27+
- There's a new method, [**Queued Visitors Left**](/data-reporting/reports-api/v3.6/#queued_visitors_left), which returns queue records for visitors who left the queue during the specified period.
2528

2629
## [v3.5] - 2022-11-23
2730

0 commit comments

Comments
 (0)