FalconryScale
DevelopersAPI reference

Log a training, flight, or hunting activity

Records a training, flight-exercise, or hunting session for a raptor on the caller's behalf, with optional training details (creance length, recall distance in metres) and, for a hunt, the outcome, prey count and slip assessment. For feeding, use log_feeding instead.

POST
/raptors/{raptorId}/activities

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.

Path Parameters

raptorId*string

Opaque Convex document id.

Lengthlength <= 64

Request Body

application/json
  1. body
activityType*string

Feeding is logged separately via log_feeding.

Value in"training""hunting""flight_exercise"
activityDate*string

ISO 8601 date (yyyy-mm-dd).

Lengthlength <= 32
startTime?string

HH:MM time of day.

Lengthlength <= 16
durationMinutes?number
Range0 < value
locationDescription?string
Lengthlength <= 500
preFlightWeightGrams?number
Range0 < value
postFlightWeightGrams?number
Range0 < value
preyCount?integer

Hunting only.

Range0 <= value <= 9007199254740991
successOutcome?boolean

Hunting only: whether the slip succeeded.

notes?string
Lengthlength <= 2000
activitySubtype?string

Free-form subtype, e.g. "lure", "creance", "game hawking".

Length1 <= length <= 100
behavioralTags?array<>

Short behaviour tags, e.g. "keen", "mantling".

Itemsitems <= 20
creanceLengthM?number

Training only: creance line length, metres.

Range0 < value <= 5000
recallDistanceM?number

Training only: recall distance, metres.

Range0 < value <= 5000
slipAssessment?

Hunting only: how the slip went. Each advantage is the bird's edge from 0 to 100.

Response Body

Log a training, flight, or hunting activity

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
activityType*string
Value in"training""hunting""feeding""flight_exercise""health_observation""transport"
activityDate*string

ISO 8601 date (yyyy-mm-dd).

startTime*|

HH:MM time of day.

durationMinutes*number|null
locationDescription*string|null
preFlightWeightGrams*number|null
postFlightWeightGrams*number|null
weightChangeGrams*number|null
preyCount*number|null
successOutcome*|

Whether a hunting slip was successful.

activitySubtype*string|null
behavioralTags*array<string>
creanceLengthM*|

Training: creance line length, metres.

recallDistanceM*|

Training: recall distance, metres.

slipAssessment*|

Hunting only: the slip assessment (each advantage 0 to 100), when one was recorded.

notes*string|null
loggedByName*string|null
Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/raptors/string/activities' \
  -H 'Content-Type: application/json' \
  -d '{
  "activityType": "training",
  "activityDate": "string"
}'
Example Response
{
  "id": "string",
  "activityType": "training",
  "activityDate": "string",
  "startTime": "string",
  "durationMinutes": 0,
  "locationDescription": "string",
  "preFlightWeightGrams": 0,
  "postFlightWeightGrams": 0,
  "weightChangeGrams": 0,
  "preyCount": 0,
  "successOutcome": true,
  "activitySubtype": "string",
  "behavioralTags": [
    "string"
  ],
  "creanceLengthM": 0,
  "recallDistanceM": 0,
  "slipAssessment": {
    "heightAdvantage": 0,
    "speedAdvantage": 0,
    "proximityAdvantage": 0,
    "surpriseAdvantage": 0,
    "coverAdvantage": 0,
    "preyEscapeMethod": "outran",
    "birdUsedHeightEffectively": true
  },
  "notes": "string",
  "loggedByName": "string"
}

List a raptor’s activities

Returns one raptor’s logged activities (feeding, training, hunting, flight exercise, health observation, transport), newest first. Filter by `activityType` and/or a `from`/`to` date range.

Get one activity

Returns one feeding, training, hunting or other activity by id, with every recorded detail. 404s if it does not exist, was deleted, or is not visible to the caller.