Translations:Stat API/44/en: Difference between revisions

Latest revision as of 17:10, 10 April 2024

Information about message (contribute)

This message has no documentation. If you know where or how this message is used, you can help other translators by adding documentation to this message.

Message definition (Stat API)

==== API ====
{| class="wikitable"
!Key
!Type
!Description
|-
| success || Boolean || Was the request successful or it failed
|-
| code || Number || Response status code
|-
|msg || [String] || Error message
|-
| colspan="3" |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
|}
{| class="wikitable mw-collapsible"
|+
Description <row>
!Key
!Type
!Description
|-
|value
|String
|Human readable value
|-
|rawValue
|String
|Raw value
|-
|diff
|<nowiki>String | null</nowiki>
|
|-
|percent
|<nowiki>Number | null</nowiki>
|Is the value a percentage or not?
|-
|compare_value
|<nowiki>String | null</nowiki>
|Comparison value if compare is on in request
|}
{| class="wikitable mw-collapsible"
|+
Description <column>
!Key
!Type
!Description
|-
|field
|String
|ID of the metric or group
|-
|type
|<nowiki>String | Number | Float</nowiki>
|
|-
|sortable
|Boolean
|Sortable or not
|-
|unit
|<nowiki>String | null</nowiki>
|Unit of measurement
For example, % for percentage columns
|}

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

Description <row>
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

Description <column>
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