Search…
Core API

Overview

The Xyte Core APIs allow Organizations to access historical information about their devices.

Authentication & Authorization

Request must be authenticated and authorized by adding a special Header to each request containing the Organization Key (available in https://app.xyte.io/settings/api_keys)
Value
Key
Organization Key
Authorization

Query parameters

All results are paginated into a maximum of 1000 results per query.
Param
Type
Description
from
Number
Date time to start from (epoch time)
to
Number
Date time to end query (epoch time)
page
Number
Which page of the pagination to bring (default 1)
device_id
String
Limit results to a single device - by ID
name
String
Limit results to a single device - by Name
space_id
String
Limit results to all devices within a space
status
String
Limit results to all devices with a single status

Returned data

The data is returned in a JSON format with pagination information.
{
"items": [],
"items_count": 0,
"page": 1,
"last_page": 0,
"total_items": 0,
"is_last_page": false
}
The items array contains a row for each device history entry:
{
"uuid": "67198d..",
"name": "Device's friendly name",
"model": "Device Model",
"partner": "Partner name",
"space_id": 3220,
"state": {
"status": "online",
"key": "value"
},
"created_at": "2022-07-08T17:15:00.000Z"
}
Copy link
On this page
Overview
Authentication & Authorization
Query parameters
Returned data