Analytics API (TypeScript)

Methods, examples, and parameters for client.analytics.

Module Overview

Track usage, latency, and provider-level breakdowns for your TheRouter.ai traffic.

Available Methods

client.analytics.list() - Fetch recent analytics buckets.
client.analytics.query() - Run filtered analytics queries.
client.analytics.export() - Export analytics rows as CSV.

Examples

TypeScript

import { TheRouter.ai } from "@therouter/sdk";

const client = new TheRouter.ai({ apiKey: process.env.THEROUTER_API_KEY! });

const report = await client.analytics.query({
  start: "2026-02-01T00:00:00Z",
  end: "2026-02-02T00:00:00Z",
  group_by: ["model"],
});

console.log(report.data.length);

analytics-response.json

{
  "id": "req_01HXYZ123",
  "module": "analytics",
  "status": "ok"
}

Parameter Types

Name	Type	Required	Description
start	string (ISO datetime)	Required	Start time for the analytics window.
end	string (ISO datetime)	Required	End time for the analytics window.
group_by	string[]		Dimension keys such as model or provider.

SDK parity

Method signatures are aligned across SDKs so migration between TypeScript and Python stays predictable.