Skip to content

Latest commit

 

History

History
168 lines (131 loc) · 2.68 KB

devices.md

File metadata and controls

168 lines (131 loc) · 2.68 KB

Devices

Top devices without model

Get the top 30 devices without the model.

Request

GET /domains/:domainId/devices?sorting=top&type=noModel
GET /domains/:domainId/devices?sorting=top&type=noModel&range=daily
GET /domains/:domainId/devices?sorting=top&type=noModel&range=weekly
GET /domains/:domainId/devices?sorting=top&type=noModel&range=monthly
GET /domains/:domainId/devices?sorting=top&type=noModel&range=allTime

Headers

Name Example
Authorization Authorization: Bearer :tokenId

Response

Status: 200 OK
{
	"type": "devices",
	"data": [
		{
			"type": "device",
			"data": {
				"id": "Apple",
				"count": 1
			}
		}
	]
}

Top devices with model

Get the top 30 devices with the model.

Request

GET /domains/:domainId/devices?sorting=top&type=withModel
GET /domains/:domainId/devices?sorting=top&type=withModel&range=daily
GET /domains/:domainId/devices?sorting=top&type=withModel&range=weekly
GET /domains/:domainId/devices?sorting=top&type=withModel&range=monthly
GET /domains/:domainId/devices?sorting=top&type=withModel&range=allTime

Headers

Name Example
Authorization Authorization: Bearer :tokenId

Response

Status: 200 OK
{
	"type": "devices",
	"data": [
		{
			"type": "device",
			"data": {
				"id": {
					"deviceManufacturer": "Apple",
					"deviceName": "iPad"
				},
				"count": 1
			}
		}
	]
}

Recent devices without model

Get the 30 most recent devices without the model.

Request

GET /domains/:domainId/devices?sorting=recent&type=noModel

Headers

Name Example
Authorization Authorization: Bearer :tokenId

Response

Status: 200 OK
{
	"type": "devices",
	"data": [
		{
			"type": "device",
			"data": {
				"id": "Apple",
				"created": "2019-09-19T15:54:00.020Z"
			}
		}
	]
}

Recent devices with model

Get the 30 most recent devices with the model.

Request

GET /domains/:domainId/devices?sorting=recent&type=withModel

Headers

Name Example
Authorization Authorization: Bearer :tokenId

Response

Status: 200 OK
{
	"type": "devices",
	"data": [
		{
			"type": "device",
			"data": {
				"id": {
					"deviceManufacturer": "Apple",
					"deviceName": "iPad"
				},
				"created": "2019-09-19T15:54:00.020Z"
			}
		}
	]
}