FalconryScale
DevelopersAPI reference

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.

GET
/activities/{activityId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

activityId*string

An activity's id, from list_activities.

Lengthlength <= 64

Response Body

Get one 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
raptorId*string

Opaque Convex document id.

Lengthlength <= 64
raptorName*string|null
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/activities/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",
  "raptorId": "string",
  "raptorName": "string"
}

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.

Correct an activity

Edits a logged activity. Only the fields you send change; null clears an optional field. The weight change is recomputed from the pre/post flight weights. A hunt's outcome and slip assessment can't be edited after logging. Team members may edit only rows they logged themselves; owners and admins may edit any.