Overview
beta.Analytics endpointsAvailable Operations
- getAnalyticsMeta - Get available analytics metrics and dimensions
- queryAnalytics - Query analytics data
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
beta.Analytics endpoints
import { OpenRouter } from "@openrouter/sdk";
const openRouter = new OpenRouter({
httpReferer: "<value>",
appTitle: "<value>",
appCategories: "<value>",
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
});
async function run() {
const result = await openRouter.beta.analytics.getAnalyticsMeta();
console.log(result);
}
run();
import { OpenRouterCore } from "@openrouter/sdk/core.js";
import { betaAnalyticsGetAnalyticsMeta } from "@openrouter/sdk/funcs/betaAnalyticsGetAnalyticsMeta.js";
// Use `OpenRouterCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const openRouter = new OpenRouterCore({
httpReferer: "<value>",
appTitle: "<value>",
appCategories: "<value>",
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
});
async function run() {
const res = await betaAnalyticsGetAnalyticsMeta(openRouter);
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("betaAnalyticsGetAnalyticsMeta failed:", res.error);
}
}
run();
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetAnalyticsMetaRequest | :heavy_check_mark: | The request object to use for the request. |
options | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.UnauthorizedResponseError | 401 | application/json |
| errors.ForbiddenResponseError | 403 | application/json |
| errors.InternalServerResponseError | 500 | application/json |
| errors.OpenRouterDefaultError | 4XX, 5XX | */* |
import { OpenRouter } from "@openrouter/sdk";
const openRouter = new OpenRouter({
httpReferer: "<value>",
appTitle: "<value>",
appCategories: "<value>",
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
});
async function run() {
const result = await openRouter.beta.analytics.queryAnalytics({
requestBody: {
dimensions: [
"model",
],
granularity: "day",
limit: 100,
metrics: [
"request_count",
],
timeRange: {
end: new Date("2025-01-08T00:00:00Z"),
start: new Date("2025-01-01T00:00:00Z"),
},
},
});
console.log(result);
}
run();
import { OpenRouterCore } from "@openrouter/sdk/core.js";
import { betaAnalyticsQueryAnalytics } from "@openrouter/sdk/funcs/betaAnalyticsQueryAnalytics.js";
// Use `OpenRouterCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const openRouter = new OpenRouterCore({
httpReferer: "<value>",
appTitle: "<value>",
appCategories: "<value>",
apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
});
async function run() {
const res = await betaAnalyticsQueryAnalytics(openRouter, {
requestBody: {
dimensions: [
"model",
],
granularity: "day",
limit: 100,
metrics: [
"request_count",
],
timeRange: {
end: new Date("2025-01-08T00:00:00Z"),
start: new Date("2025-01-01T00:00:00Z"),
},
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("betaAnalyticsQueryAnalytics failed:", res.error);
}
}
run();
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.QueryAnalyticsRequest | :heavy_check_mark: | The request object to use for the request. |
options | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponseError | 400 | application/json |
| errors.UnauthorizedResponseError | 401 | application/json |
| errors.ForbiddenResponseError | 403 | application/json |
| errors.RequestTimeoutResponseError | 408 | application/json |
| errors.InternalServerResponseError | 500 | application/json |
| errors.OpenRouterDefaultError | 4XX, 5XX | */* |