/Statistics GET

Returns a an array of statistics

URL

/Statistics

Verb

Get

Headers

Header	Data Type	Valid Values	Required	Description
Content-Type	string	application/json	YES	The format your data will be sent to our site.
X-DevKey	string	string	YES	The devkey assigned to the developer.
X-AccessToken	string	string	YES	The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the query string of the request.

Parameter	Data Type	Valid Values	Description
CollectionID	integer	Valid statistics collection ID	The statistics collection to return

Output

If the CollectionID is not valid, you will receive a 400 Bad Request and a Message Response indicating the reason.

If the CollectionID is valid, this call will respond with a 200 OK and the following data as serialized JSON

Main Body

Parameter	Data Type	Valid Values	Description
CollectionID	integer	Valid statistics collection ID	The statistics collection ID that was requested
Description	string	string	The description of the collection
ExpirationMinutes	integer	positive #	The number of minutes configured for the client to cache the data returned
Statistics	Array	Array of Statistics Objects (see below)	The values to display for the statistics in the requested collection, ordered by the configured SortOrder

Statistics

Parameter	Data Type	Valid Values	Description
Value	string	string	The value to display, formatted as configured for the number format and number of decimal places
Title	string	string	The title of the statistic to display to the user.
Description	string	string	The description of the statistic to display to the user as a tooltip.
SortOrder	integer	positive #	The sort order in which to display the statistics.