GET Top Devices

Overview

---

The following table contains important information about the GET method in regards to receiving the top devices by usage for the platform in the last 24 hours.

GET Top Devices
Method	GET
URL or Endpoint	/api/v1/projects/projectId/dashboard/topDevices
Headers	Authorization
Parameters	projectId, items
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project

The description of the query parameters is as follows:

Parameter Name	Mandatory	Type	Description
items	No	integer($int32)	The number of top devices to return.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": [
    {
      "deviceType": "string",
      "deviceTypeNr": 0
    }
  ],
  "resultInfo": "string",
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from back-end.
result	array[object]	Returns the list of devices and their corresponding usage counts.
deviceType	string	Returns the name of the device type.
deviceTypeNr	integer($int32)	Returns the number of occurrences or views from that device.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed