Migration Guide: Transition to Region-Based Telemetry Retrieval
As part of our improvements, Dronetag is transitioning to region-based and timeline-based telemetry retrieval. This change requires you to update how you query telemetry and real-time data by specifying a geographical region or time range for telemetry retrieval. Follow this guide to ensure a smooth transition to the new system.
Affected Areas
- All HTTP requests querying post-flight telemetry from
api.dronetag.app
- Endpoints:
https://api.dronetag.app/v1/flights/*/telemetry*
https://api.dronetag.app/v1/devices/*/status-history
- Endpoints:
- All HTTP requests querying live telemetry from
live.dronetag.app
- Endpoints:
https://live.dronetag.app/api/v2/airspace/overview
https://live.dronetag.app/api/v2/devices/*/telemetry
https://live.dronetag.app/api/v2/devices/*/status_history
https://live.dronetag.app/api/v2/flights/*/telemetry
- Endpoints:
- All Socket.IO connections for real-time flight telemetry from
live.dronetag.app
Key Changes
- Geographical bounds or UAS ID (device serial number) are now required for all telemetry retrievals.
- The service has switched from UAS ID to Operation ID for identifying flying objects.
- Our telemetry endpoints now use a new data format called DUMP which will be consistently used across our services.
- Several endpoints, including
https://live.dronetag.app/api/v2/airspace/overview
, will be deprecated by February 2025.
Migration Timeline
- February 2025: All deprecated API and Socket.IO endpoints on
live.dronetag.app
will be removed. Complete your migration by this date.
Step-by-Step Migration
1. Migrate to api.dronetag.app/v2/airspace
for Telemetry Retrieval
To retrieve telemetry, replace live.dronetag.app
queries with api.dronetag.app/v2/airspace
.
Replace GET https://live.dronetag.app/api/v2/airspace/overview
- Use
GET https://api.dronetag.app/v2/airspace/telemetry/ua
. - Specify a time range, geographical bounds, or UAS ID.
- Note: Flying objects are now identified by Operation ID. Retrieve the UAS ID using
/operations/{operation_id}
.
Replace GET https://live.dronetag.app/api/v2/devices/*/telemetry
- Use
GET https://api.dronetag.app/v2/airspace/telemetry/ua?uas_id=xxx
with a UAS ID filter. - You may need
/operations/{operation_id}
to retrieve the UAS ID.
Replace GET https://live.dronetag.app/api/v2/devices/*/status_history
- Device status history is now part of system telemetry.
- Use
GET https://api.dronetag.app/v2/airspace/telemetry/system?uas_id=xxx
with a UAS ID filter.
Replace GET https://live.dronetag.app/api/v2/flights/*/telemetry
- Flight telemetry is now linked to Operation ID.
- Use
GET https://api.dronetag.app/v2/airspace/telemetry/ua?operation_id=xxx
.
2. Migrate to api.dronetag.app/v2/airspace
for Socket.IO Connections
- Socket.IO services on
live.dronetag.app
will be deprecated. Useapi.dronetag.app/v2/airspace
for real-time telemetry. - After connecting, send a viewport message to define the geographical region you are monitoring. Regular updates are required during the session.
- Refer to the Getting Started with Socket.io page for details.
3. Migrate to api.dronetag.app/v2/airspace
for Post-Flight Data
Post-flight telemetry is now retrieved through the same API as real-time data. Use your flight_id
as operation_id
in new requests.
Replace GET https://api.dronetag.app/v1/flights/*/telemetry*
- Use
GET https://api.dronetag.app/v2/airspace/telemetry/ua?operation_id=xxx
with Operation ID and flight start/end times.
Replace GET https://api.dronetag.app/v1/flights/*/status-history*
- Use
GET https://api.dronetag.app/v2/airspace/telemetry/system?operation_id=xxx
with Operation ID and flight start/end times.