| Method | get.reports_list |
|---|---|
| Description | Retrieving all user reports |
| Available to | Agent, Client |
| Necessary components for working with the method | Data API for configuration |
| Method weight | 1 point |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift - determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering Criteria" |
fields |
array | no | See "View of Returned Data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Name | Type | Valid values | Filtering | Sorting | Default response | Description |
|---|---|---|---|---|---|---|
id |
number | yes | yes | yes | User report unique identifier | |
type |
enum |
|
yes | yes | yes | User report type |
name |
string | yes | User report name | |||
description |
string | yes | User report description | |||
group_id |
number | yes | Report group ID | |||
sort |
number | Sorting reports in the menu | ||||
is_mobile |
boolean | yes | yes | The report is used in the mobile version of the account | ||
is_editable |
boolean | yes | yes | Is it editable | ||
is_favorite |
boolean | yes | yes | Is the report a favorite | ||
date_time_added_to_favorite |
iso8601 | YYYY-MM-DD hh:mm:ss | yes | yes | Date and time the report was added to favorites |
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.reports_list", "params":{ "access_token":"string", "user_id":"number", "offset":"number", "limit":"number", "filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
### JSON response structure```JSON
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": [
{
"id": "number",
"type": "enum",
"name": "string",
"description": "string",
"group_id": "number",
"sort": "number",
"is_mobile": "boolean",
"is_editable": "boolean",
"is_favorite": "boolean",
"date_time_added_to_favorite": "iso8601"
}
]
}
}
JSON Example response```JSON
{
"result": {
"metadata": {
"total_items": 1
},
"data": [
{
"name": "Анализ трафика",
"type": "summary_analytics",
"id": 2,
"description": null,
"group_id": 6,
"sort": 200,
"is_mobile": false,
"is_editable": false,
"is_favorite": true,
"date_time_added_to_favorite": "2024-08-20 13:54:07"
}
]
},
"id": "1",
"jsonrpc": "2.0"
}
```
List of returned errors
See the section "List of errors for methods with the verb get"