Skip to main content
Version: 1.0.0

Destiny HTTP History Query API

Introduction

Welcome to the History Query API documentation. This API provides the means to gain access to historically captured telemetry, trip and summary data for all the vehicles and units available to you.

The API uses the same authentication as the regular HTTP API and therefore does not require a separate login request.

Request URL Instructions

Arguments within the queries are indicated with curly braces ({ and \}) but the curly braces should not be included, for example, if the example looks like this:

api/v1/history/telemetry/unit/{unit_id}/date/{date}/from/{from}/to/{to}

then the actual request will look something like this:

api/v1/history/telemetry/unit/1/date/2021-04-30/from/08:00:00/to/17:00:00

Common URL Arguments

  • unit_id: A particular unit's database id.
  • vehicle_id: A particular vehicle's database id (usually with an accompanying assigned_as argument).
  • assigned_as: A string indicating the primary, backup_1 or backup_2 unit that is assigned to the vehicle.
  • client_id: A particular client's database id.
  • group_id: Either a vehicle group's or unit group's database id.
  • from_date: A particular date in the format YYYY-MM-DD (e.g. 2020-04-30)
  • to_date: A particular date in the format YYYY-MM-DD (e.g. 2020-04-30)
  • from_time: A time in a 24-hour format HH:MM:SS (e.g. 17:30:45).
  • to_time: A time in a 24-hour format HH:MM:SS (e.g. 17:30:45).

Request Results

These results are returned in the same format as regular HTTP API GET requests, for example:

{
  "data": []
}

Authentication​

Destiny bearer token from the authentication endpoint.

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer