Fetch a list of Incidents

GET

/incidents

const url = 'https://app.bluelightmaps.com/api/incidents?sortBy=timeOfOrigin&sortOrder=ASC&limit=100&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://app.bluelightmaps.com/api/incidents?sortBy=timeOfOrigin&sortOrder=ASC&limit=100&offset=0' \
  --header 'Authorization: Basic <credentials>'

Retrieve incidents with filtering, sorting, and pagination options. Without any params, returns a list of incidents the user has access to, open and closed alike - filter with status to get one or the other.

Authorizations

BasicAuth
ApiKey

Parameters

Query Parameters

from

string format: date-time

Start time in ISO 8601 format (filters by timeOfOrigin)

string format: date-time

End time in ISO 8601 format (filters by timeOfOrigin)

type

Array<string>

Incident type(s) to filter by

status

Array<string>

Allowed values: OPEN CLOSED

Incident status(es) to filter by. Repeat the parameter to match several (?status=OPEN&status=CLOSED).

minPriority

integer

Minimum priority value (inclusive)

maxPriority

integer

Maximum priority value (inclusive)

description

string

Partial match for incident description (case-insensitive)

sortBy

string

default: timeOfOrigin

Allowed values: timeOfOrigin priority type id description status

Field to sort by (default: timeOfOrigin). Any value outside this list silently falls back to timeOfOrigin.

sortOrder

string

default: DESC

Allowed values: ASC DESC

Sort order (ASC or DESC)

limit

integer

default: 100 >= 1

Maximum number of results to return (default: 100)

offset

integer

Number of results to skip, for pagination (default: 0)

Responses

200

application/json

Array<object>

object

integer format: int64

originId

required

Unique external identifier for the incident

string

type

required

Type of incident

string

timeOfOrigin

Time when the incident occurred

string format: date-time

timeReceived

Time when the incident was received by the system

string format: date-time

timeUpdated

Time when the incident was last updated

string format: date-time

status

Lifecycle state. Incidents are created OPEN; status in a create body is ignored. On an update, omit it to keep the stored value, send CLOSED to close (which stands every remaining callsign down and stamps timeClosed) or OPEN to reopen (which clears timeClosed). Any other value is a 400, and assigning resources while closed is a 409.

string

default: OPEN

Allowed values: OPEN CLOSED

timeClosed

When the incident was closed; absent (null) while it is open. Server-owned: set when status becomes CLOSED, cleared when it goes back to OPEN, and ignored if sent in a request body.

string format: date-time

latitude

required

Latitude of the incident location

number format: double

longitude

required

Longitude of the incident location

number format: double

priority

required

Priority of the incident

integer

description

Description of the incident

string

<= 255 characters

resources

Callsigns assigned to this incident. A callsign is matched against the names of the devices the caller can reach, and one callsign may map to several devices (a vehicle often carries more than one) - each of them receives the assignment / deassignment event and push. Always empty while the incident is closed.

Array<string>

Example

[
  {
    "status": "OPEN"
  }
]

400

Limit is not greater than 0, offset is negative, or a status value is not OPEN or CLOSED