Histories
Overview
This API allows 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).
If no 'from' and 'to' params are provided, then the default fetch is for the last week.
Value | Key |
---|---|
Organization Key | Authorization |
GET
https://hub.xyte.io/core/v1/organization/devices/histories
All results are paginated into a maximum of 1000 results per query. The data is returned in a JSON format with pagination information. The items array contains a row for each device history entry:
Query Parameters
Name | Type | Description |
---|---|---|
from | String | Date time to start from (epoch time) |
to | String | Date time to end query (epoch time) |
page | String | Which page of the pagination to bring (default 1) |
device_id | String | Limit results to a single device - by ID |
space_id | String | Limit results to all devices within a space |
status | String | Limit results to all devices with a single status |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | API_KEY |
Error Handling
401 Unauthorized: If the api_key is not provided or is invalid.
403 Forbidden: If the user does not have permission to perform the requested action.
Last updated