FalconryScale
DevelopersAPI reference

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
/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

Query Parameters

activityType?string
Value in"training""hunting""feeding""flight_exercise""health_observation""transport"
from?string

ISO 8601 date (yyyy-mm-dd). Only activities on or after this date.

Lengthlength <= 32
to?string

ISO 8601 date (yyyy-mm-dd). Only activities on or before this date.

Lengthlength <= 32
limit?integer

Cap the number of rows returned, newest first. Default 50.

Range0 < value <= 200

Response Body

List a raptor’s activities

application/json
  1. response
activities*array<>
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/raptors/string/activities'
Example Response
{
  "activities": [
    {
      "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"
    }
  ]
}

Delete a weigh-in

Permanently deletes one weigh-in. This cannot be undone. Before calling, read the entry back to the user (weight, date and raptor) and get their explicit confirmation.

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.