Lc new reports endpoints #1520
Merged
Lc new reports endpoints #1520
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
There's a mismatch in category name. In the menu, it's Stats, while it's Customers in the table Perhaps Stats should be renamed to Customers and the new |
skamieniarz
reviewed
Mar 4, 2025
Comment on lines
824
to
876
| ### Groups | ||
|
|
||
| Shows the total number of chats were handled by each group during the specified period. | ||
|
|
||
| #### Specifics | ||
|
|
||
| | | | | ||
| | ------------------- | ------------------------------------------------------------ | | ||
| | **Method URL** | `https://api.livechatinc.com/v3.6/reports/chats/groups` | | ||
| | **HTTP method** | POST, GET | | ||
| | **Required scopes** | `reports_read` | | ||
|
|
||
| #### Request | ||
|
|
||
| See [available parameters and filters](#available-parameters-and-filters). | ||
|
|
||
| #### Response | ||
|
|
||
| | Field | Notes | | ||
| | ------------------------ | -------------------------------------------------------- | | ||
| | `total` | The total number of chats in the specified date range. | | ||
| | `records` | Contains the `distribution` objects, for example, `day`. | | ||
| | `records.day.group` | Contains the `<group>:<chat_count>` pairs. | | ||
|
|
||
| </Text> | ||
| <Code> | ||
| <CodeSample path={'REQUEST'}> | ||
| <Sample> | ||
|
|
||
| ```shell | ||
| curl -X POST \ | ||
| https://api.livechatinc.com/v3.6/reports/chats/groups \ | ||
| -H 'Content-Type: application/json' \ | ||
| -H 'Authorization: Bearer <your_access_token>' \ | ||
| -d '{ | ||
| "distribution": "day", | ||
| "filters": { | ||
| "from": "2024-08-20T00:00:00-00:00", | ||
| "to": "2024-08-22T23:59:59-00:00" | ||
| } | ||
| }' | ||
| ``` | ||
|
|
||
| </Sample> | ||
| </CodeSample> | ||
|
|
||
| <CodeResponse type="reports" version="v3.6" json="groups"/> | ||
|
|
||
| </Code> | ||
| </Section> | ||
|
|
||
| <Section> | ||
| <Text> |
skamieniarz
reviewed
Mar 18, 2025
Co-authored-by: skamieniarz <46318321+skamieniarz@users.noreply.github.com>
Co-authored-by: skamieniarz <46318321+skamieniarz@users.noreply.github.com>
Co-authored-by: Ola <42515529+ale-kacperczyk@users.noreply.github.com>
Co-authored-by: Ola <42515529+ale-kacperczyk@users.noreply.github.com>
Co-authored-by: Ola <42515529+ale-kacperczyk@users.noreply.github.com>
Co-authored-by: skamieniarz <46318321+skamieniarz@users.noreply.github.com>
Co-authored-by: skamieniarz <46318321+skamieniarz@users.noreply.github.com>
Collaborator
|
Hi there, is this ready for review or are you still working on this PR? |
Contributor
Author
applied some comments |
oliwiapolec
approved these changes
Jul 9, 2025
|
🎉 This PR is included in version 2.11.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deploy preview
Scroll down to the checks section for the link to the deploy preview of your branch.
Links
Link your Jira ticket.
Description
Review and release
Apply changes and resolve conflicts. Once the described functionality lands on prod, let us know on #platform-docs-releases that your PR is ready for release. We will merge and publish the changes.