Translations:Stat API/44/en
API
| Key | Type | Description |
|---|---|---|
| success | Boolean | Was the request successful or it failed |
| code | Number | Response status code |
| msg | [String] | Error message |
| data | ||
| data.rows | [<row>] | Description of table rows |
| data.totalRows | Number | Total number of items in the table |
| data.total | <row> | Sum for each column considering invisible rows |
| data.page | Number | Current page |
| data.perPage | Number | Number of items per page |
| data.columns | [<column>] | Description of columns |
| Key | Type | Description |
|---|---|---|
| value | String | Human readable value |
| rawValue | String | Raw value |
| diff | String | null | |
| percent | Number | null | Is the value a percentage or not? |
| compare_value | String | null | Comparison value if compare is on in request |
| Key | Type | Description |
|---|---|---|
| field | String | ID of the metric or group |
| type | String | Number | Float | |
| sortable | Boolean | Sortable or not |
| unit | String | null | Unit of measurement
For example, % for percentage columns |