ScoutsScout model spend

Scout model spend

Reported BYOK spend on scout model calls, counting every provider call including failed and repaired ones. Totals plus one row per scout. Calls whose cost the provider did not report are counted in unknown_cost_calls; the provider's bill is authoritative.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/usage?location_id=example_string&date_from=2024-12-25&date_to=2024-12-25" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "date_from": "2024-12-25",
    "date_to": "2024-12-25",
    "spend_label": "Reported spend on scout model calls",
    "totals": {
      "runs": 42,
      "calls": 42,
      "known_cost_usd": 3.14,
      "unknown_cost_calls": 42,
      "input_tokens": 42,
      "output_tokens": 42
    },
    "scouts": [
      {
        "scout_id": "123e4567-e89b-12d3-a456-426614174000",
        "location_id": "example_string",
        "runs": 42,
        "calls": 42,
        "known_cost_usd": 3.14,
        "unknown_cost_calls": 42
      }
    ]
  }
}
GET
/client/v1/scouts/usage
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.
query
location_idstring

Only this client.

query
date_fromstring

Inclusive UTC date. Default: the first day of this month.

Format: date
query
date_tostring

Inclusive UTC date. Default: today. At most 92 days after date_from.

Format: date
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Query Parameters

location_idstring

Only this client.

date_fromstring

Inclusive UTC date. Default: the first day of this month.

date_tostring

Inclusive UTC date. Default: today. At most 92 days after date_from.

Responses

successboolean
dataobject