Flights

Search Flights

Search for Flights of the specified Nest. This endpoint is especially useful for applications that need to inspect Flight error messages to understand failed or cancelled Flights.

get/nests/{nestId}/birds/{birdId}/flights

Request

  • Base URL: https://eu-1.blackbird.io/api-rest
  • URL: https://eu-1.blackbird.io/api-rest/nests/{nestId}/birds/{birdId}/flights
  • Auth: API key in header Authorization

Path parameters

nestIdstring required

The ID of the Nest that contains the Bird.

birdIdstring required

The ID of the Bird whose Flights are being listed.

Query parameters

MinStartDatestring date-time

Filters Flights to those with a start date on or after this timestamp.

MaxStartDatestring date-time

Filters Flights to those with a start date on or before this timestamp.

Status'succeeded' | 'failed' | 'cancelled' | 'active'

Filters Flights by status. Active Flights are currently running. Cancelled Flights were cancelled by a user.

Response

A list of Flights for the specified Bird, including error messages when available.

idstring
birdIdstring
nestIdstring
status'succeeded' | 'failed' | 'cancelled' | 'active'
errorMessagesstring nullable

Error details for the Flight when available. This field is especially useful for applications that need to diagnose failed or cancelled Flights.

startDatestring date-time
durationinteger

Changes

No recorded changes to this operation across all 1 revision of this API.