Skip to content

EUEE-1145 abandoned cart docs v37 #1659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GGuinea wants to merge 1 commit into
base: master
Choose a base branch
from
+89 −0
Open

EUEE-1145 abandoned cart docs v37 #1659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions payloads/data-reporting/v3.7/reports-api/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
25 changes: 25 additions & 0 deletions payloads/data-reporting/v3.7/reports-api/responses/sales/abandonedCarts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
}
}
63 changes: 63 additions & 0 deletions src/pages/data-reporting/reports-api/v3.7/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |

Expand Down Expand Up @@ -1152,6 +1153,68 @@ https://api.livechatinc.com/v3.7/reports/chats/queued_visitors_left \
</Code>
</Section>

## Sales

<Section>
<Text>

### 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. |

</Text>
<Code>

<CodeSample path={'REQUEST'}>

<Sample>

```shell
curl -X POST \
https://api.livechatinc.com/v3.7/reports/sales/abandoned_carts \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic <your_personal_access_token>' \
-d '{
"distribution": "day",
"timezone": "UTC",
"filters": {
"from": "2026-03-19T00:00:00Z",
"to": "2026-03-20T23:59:59Z"
}
}'
```

</Sample>
</CodeSample>

<CodeResponse type="reports" version="v3.7" json="abandonedCarts"/>

</Code>
</Section>

## Tags

<Section>
Expand Down
Loading