Histories

Retrieve historical information about your devices using our API.

This API allows organizations to access historical information about their devices.

Authentication & Authorization

All requests must be authenticated and authorized by adding a special Header to each request containing the Organization Key. See how to get your API Keys which must be entered in the Authorization field.

ValueKey
Organization KeyAuthorization

Get a list of historical information

This endpoint returns a paginated list of historical information.

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

NameTypeDescription
from*stringDate time to start from (epoch time).
to*stringDate time to end query (epoch time).
pagestringWhich page of the pagination to bring (default 1).
device_idstringLimit results to a single device - by ID.
space_idstringLimit results to all devices within a space.
statusstringLimit results to all devices with a single status.

* If no from and to parameters are provided, then the default fetch is for the last week.

Headers

NameTypeDescription
Authorization*stringAPI_KEY

Error Handling

  • 401 Unauthorized: the api_key is not provided or is invalid.
  • 403 Forbidden: the user does not have permission to perform the requested action.