Incidents

Overview

This API allows Organizations to access historical information about their incidents.

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/incidents/

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	DateTime	Date time to start from (epoch time)
to	DateTime	Date time to end query (epoch time)
page	integer	Which page of the pagination to bring (default 1)
page_size	integer	max 500
space_id	String	Limit results to all devices within a space
status	String	Limit results to all devices with a single status . active / closed
priority	String	critical / high / moderate / low / planning
title	String	Incident's title
description	String	Incident's description
issue	String	Incident's issue name
device_model	String	Device's model name
partner_name	String	Partner's name
sub_model	String	The sub model of the device to filter on.

Headers

Name	Type	Description
Authorization*	String	API_KEY

200: OK

{
    "items": [
    {
	"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"
}
],
    "has_next_page": true
}

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.