@anthropic-ai/sdk
Version:
The official TypeScript library for the Anthropic API
51 lines • 1.96 kB
JavaScript
import { APIResource } from "../../../../core/resource.mjs";
import { ReportPageCursor } from "../../../../core/pagination.mjs";
import { startApiCallSpan } from "../../../../internal/tracing.mjs";
export class UsageReport extends APIResource {
/**
* Get token usage over time across a date range.
*
* Returns token usage bucketed by minute, hour, or day, optionally broken down by
* product, model, context window, inference region, or speed. Available to
* organizations on a Claude Enterprise plan. Requires an API key with the
* `read:analytics` scope.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const betaAnalyticsUsageReportTimeBucket of client.beta.organization.analytics.usageReport.list(
* { starting_at: '2019-12-27T18:11:19.117Z' },
* )) {
* // ...
* }
* ```
*/
list(query, options) {
return this._client.getAPIList('/v1/organizations/analytics/usage_report?beta=true', (ReportPageCursor), {
query,
...options,
__span: startApiCallSpan(this._client, 'anthropic.organization.analytics.usage_report.list', options, {
route: '/v1/organizations/analytics/usage_report',
queryParams: [
'bucket_width',
'claude_tag_categories',
'claude_tag_user_ids',
'context_windows',
'ending_at',
'group_by',
'inference_geos',
'limit',
'models',
'page',
'products',
'rbac_group_ids',
'slack_channel_ids',
'speeds',
'starting_at',
'user_ids',
],
}),
});
}
}
//# sourceMappingURL=usage-report.mjs.map