> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yutori.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Usage
> Get usage statistics over different time periods, active scouts, and rate limits.
Get usage statistics over different time periods, active scouts, and rate limits.
## Query Parameters
Time range for activity counts. One of `24h`, `7d`, `30d`, or `90d`.
```bash cURL theme={null}
curl --request GET \
--url 'https://api.yutori.com/v1/usage?period=7d' \
--header 'X-API-Key: YOUR_API_KEY'
```
```python Python theme={null}
import requests
response = requests.get(
"https://api.yutori.com/v1/usage",
headers={"X-API-Key": "YOUR_API_KEY"},
params={"period": "7d"}
)
print(response.json())
```
```javascript JavaScript theme={null}
const response = await fetch("https://api.yutori.com/v1/usage?period=7d", {
method: "GET",
headers: { "X-API-Key": "YOUR_API_KEY" }
});
const data = await response.json();
```
```json 200 theme={null}
{
"num_active_scouts": 5,
"active_scout_ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"b2c3d4e5-f6a7-8901-bcde-f12345678901",
"c3d4e5f6-a7b8-9012-cdef-123456789012",
"d4e5f6a7-b8c9-0123-defa-234567890123",
"e5f6a7b8-c9d0-1234-efab-345678901234"
],
"rate_limits": {
"requests_today": 1250,
"daily_limit": 10000,
"remaining_requests": 8750,
"reset_at": "2026-03-04T00:00:00+00:00",
"status": "available"
},
"navigator_rate_limits": {
"requests_today": 342,
"daily_limit": 50000,
"remaining_requests": 49658,
"reset_at": "2026-03-04T00:00:00+00:00",
"per_second_limit": 20
},
"n1_rate_limits": {
"requests_today": 342,
"daily_limit": 50000,
"remaining_requests": 49658,
"reset_at": "2026-03-04T00:00:00+00:00",
"per_second_limit": 20
},
"activity": {
"period": "7d",
"scout_runs": 47,
"browsing_tasks": 12,
"research_tasks": 8,
"navigator_calls": 1523,
"n1_calls": 1523
}
}
```
`n1_rate_limits` and `activity.n1_calls` are deprecated aliases of `navigator_rate_limits` and `activity.navigator_calls`. They mirror the canonical fields to give existing clients a migration window, and will be removed in a future release. Prefer the `navigator_*` names.
## OpenAPI
````yaml GET /v1/usage
openapi: 3.1.0
info:
title: FastAPI
version: 0.1.0
servers:
- url: https://api.yutori.com
description: Production
security:
- ApiKeyAuth: []
paths:
/v1/usage:
get:
tags:
- Scouting
summary: Get Usage
description: >-
Get usage statistics over different time periods, active scouts, and
rate limits.
operationId: get_usage_v1_usage_get
parameters:
- name: period
in: query
required: false
schema:
$ref: '#/components/schemas/TimeRange'
default: 24h
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UsageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
TimeRange:
type: string
enum:
- 24h
- 7d
- 30d
- 90d
title: TimeRange
UsageResponse:
properties:
num_active_scouts:
type: integer
title: Num Active Scouts
active_scout_ids:
items:
type: string
format: uuid
type: array
title: Active Scout Ids
rate_limits:
$ref: '#/components/schemas/RateLimits'
navigator_rate_limits:
$ref: '#/components/schemas/NavigatorRateLimits'
activity:
$ref: '#/components/schemas/ActivityCounts'
n1_rate_limits:
$ref: '#/components/schemas/NavigatorRateLimits'
description: >-
Deprecated alias of navigator_rate_limits; prefer
navigator_rate_limits
deprecated: true
readOnly: true
type: object
required:
- num_active_scouts
- active_scout_ids
- rate_limits
- navigator_rate_limits
- activity
- n1_rate_limits
title: UsageResponse
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
RateLimits:
properties:
requests_today:
anyOf:
- type: integer
- type: 'null'
title: Requests Today
description: API requests used today (None if unavailable)
daily_limit:
anyOf:
- type: integer
- type: 'null'
title: Daily Limit
description: >-
Daily request limit from AWS API Gateway usage plan (None if
unavailable)
remaining_requests:
anyOf:
- type: integer
- type: 'null'
title: Remaining Requests
description: Remaining requests for today (None if unavailable)
reset_at:
type: string
title: Reset At
description: ISO 8601 timestamp for next midnight UTC
status:
type: string
enum:
- available
- unavailable
title: Status
description: Rate limit availability status
type: object
required:
- requests_today
- daily_limit
- remaining_requests
- reset_at
- status
title: RateLimits
NavigatorRateLimits:
properties:
requests_today:
type: integer
title: Requests Today
description: Navigator API requests used today (since midnight UTC)
daily_limit:
type: integer
title: Daily Limit
description: Daily Navigator request limit (resets at midnight UTC)
remaining_requests:
type: integer
title: Remaining Requests
description: >-
Remaining Navigator requests for today (daily_limit -
requests_today)
reset_at:
type: string
title: Reset At
description: ISO 8601 timestamp for next midnight UTC
per_second_limit:
type: integer
title: Per Second Limit
description: Configured per-second Navigator request limit
type: object
required:
- requests_today
- daily_limit
- remaining_requests
- reset_at
- per_second_limit
title: NavigatorRateLimits
description: Rate limits for the Navigator (chat completions) endpoint.
ActivityCounts:
properties:
period:
type: string
enum:
- 24h
- 7d
- 30d
- 90d
title: Period
scout_runs:
type: integer
title: Scout Runs
browsing_tasks:
type: integer
title: Browsing Tasks
research_tasks:
type: integer
title: Research Tasks
navigator_calls:
type: integer
title: Navigator Calls
description: Navigator (chat completions) calls in period
n1_calls:
type: integer
title: N1 Calls
description: Deprecated alias of navigator_calls; prefer navigator_calls
deprecated: true
readOnly: true
type: object
required:
- period
- scout_runs
- browsing_tasks
- research_tasks
- navigator_calls
- n1_calls
title: ActivityCounts
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
ApiKeyAuth:
type: apiKey
name: x-api-key
in: header
````