reports

Get Inventory Report

Current farm reports HTTP operation. External credential scopes: read:records. Minimum farm role: READER. Production rate limit: 100 requests per 15-minute window per device account, 1000 per browser session, otherwise per client IP. RateLimit headers report the current window; respect Retry-After on 429.

get/v1/farm/{farm_id}/reports/inventory

Request

  • Base URL: https://api.ranch.bot
  • URL: https://api.ranch.bot/v1/farm/{farm_id}/reports/inventory
  • Auth: HTTP bearer

Path parameters

farm_idstring uuid required

Query parameters

preset'month' | 'quarter' | 'year' | 'custom'
fromstring
tostring

Response

Success

generatedAtstring required
byCategoryobject required
preset'custom' | 'month' | 'quarter' | 'year' required

Changes

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