diff --git a/payloads/data-reporting/v3.7/reports-api/index.js b/payloads/data-reporting/v3.7/reports-api/index.js index 46cb8d080..22daa48a7 100644 --- a/payloads/data-reporting/v3.7/reports-api/index.js +++ b/payloads/data-reporting/v3.7/reports-api/index.js @@ -17,3 +17,4 @@ export { default as uniqueVisitors } from "./responses/customers/uniqueVisitors. export { default as queuedVisitors } from "./responses/chats/queuedVisitors.json"; export { default as queuedVisitorsLeft } from "./responses/chats/queuedVisitorsLeft.json"; export { default as groups } from "./responses/chats/groups.json"; +export { default as abandonedCarts } from "./responses/sales/abandonedCarts.json"; diff --git a/payloads/data-reporting/v3.7/reports-api/responses/sales/abandonedCarts.json b/payloads/data-reporting/v3.7/reports-api/responses/sales/abandonedCarts.json new file mode 100644 index 000000000..d33e01042 --- /dev/null +++ b/payloads/data-reporting/v3.7/reports-api/responses/sales/abandonedCarts.json @@ -0,0 +1,25 @@ +{ + "name": "abandoned_carts", + "request": { + "distribution": "day", + "timezone": "UTC", + "filters": { + "from": "2026-03-19T00:00:00Z", + "to": "2026-03-20T23:59:59Z" + } + }, + "records": { + "2026-03-19": { + "abandoned_cart_count": 0, + "total_abandoned_value_usd": 0 + }, + "2026-03-20": { + "abandoned_cart_count": 1, + "total_abandoned_value_usd": 591.38 + } + }, + "summary": { + "total_abandoned_cart_count": 1, + "total_abandoned_value_usd": 591.38 + } +} diff --git a/src/pages/data-reporting/reports-api/v3.7/index.mdx b/src/pages/data-reporting/reports-api/v3.7/index.mdx index 56d0e1d3e..e7b073b09 100644 --- a/src/pages/data-reporting/reports-api/v3.7/index.mdx +++ b/src/pages/data-reporting/reports-api/v3.7/index.mdx @@ -71,6 +71,7 @@ Required scopes are listed in each method description. For the full list, see [S | **Chats** | [`duration`](#duration) [`tags`](#tags) [`total_chats`](#total-chats) [`ratings`](#ratings) [`ranking`](#ranking) [`engagement`](#engagement) [`greetings_conversion`](#greetings-conversion) [`forms`](#forms) [`response_time`](#response-time) [`first_response_time`](#first-response-time) [`groups`](#group-chats-count) | | **Agents** | [`availability`](#availability) [`performance`](#performance) | | **Customers** | [`unique_visitors`](#unique-visitors) [`queued_visitors`](#queued-visitors) [`queued_visitors_left`](#queued-visitors-left) | +| **Sales** | [`abandoned_carts`](#abandoned-carts) | | **Tags** | [`chat_usage`](#chat-usage) | | **Stats** | [`visitor_domains`](#visitor-domains) | @@ -1152,6 +1153,68 @@ https://api.livechatinc.com/v3.7/reports/chats/queued_visitors_left \ +## Sales + +
+ + +### Abandoned Carts + +Returns the number of abandoned carts and their total value during the specified period. + +#### Specifics + +| | | +| ------------------- | -------------------------------------------------------------------- | +| **Method URL** | `https://api.livechatinc.com/v3.7/reports/sales/abandoned_carts` | +| **HTTP method** | POST, GET | +| **Required scopes** | `reports_read` | + +#### Request + +See [available parameters and filters](#available-parameters-and-filters). + +#### Response + +| Field | Notes | +| ---------------------------------------- | -------------------------------------------------------- | +| `records` | Contains the `distribution` objects, for example, `day`. | +| `records.day.abandoned_cart_count` | The number of abandoned carts that `day`. | +| `records.day.total_abandoned_value_usd` | The total value (USD) of abandoned carts that `day`. | +| `summary` | A report summary. | +| `summary.total_abandoned_cart_count` | The total number of abandoned carts in the date range. | +| `summary.total_abandoned_value_usd` | The total value (USD) of all abandoned carts. | + + + + + + + + +```shell +curl -X POST \ +https://api.livechatinc.com/v3.7/reports/sales/abandoned_carts \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Basic ' \ + -d '{ + "distribution": "day", + "timezone": "UTC", + "filters": { + "from": "2026-03-19T00:00:00Z", + "to": "2026-03-20T23:59:59Z" + } + }' +``` + + + + + + + +
+ ## Tags