monitor-usage

For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

<!-- Tab options on this page. Append to the .md URL to filter: ?tabs=<id,...> select specific tabs (e.g. ?tabs=nodejs,shell) ?allTabs=true include every tab (no param) default: one tab per tabset

Available tabs: other tabs: org-level, project-level -->

Monitor Usage

You can monitor the usage of your model API keys in the Atlas UI by tracking API requests, token consumption, and costs. Usage monitoring is available at both the organization and project levels.

View Usage

You can view your API key usage at the organization or project level.

Organization Level

At the organization level, you can view comprehensive usage metrics across all projects, including free and paid usage, and access billing information.

You must have [Organization Read Only](https://www.mongodb.com/docs/atlas/reference/user-roles.md#mongodb-authrole-Organization-Read-Only or higher access to Atlas.

1. Log in to Atlas.

2. Go to the Usage page in the Atlas UI.

If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

At the organization level, click Usage under the AI Model APIs header in the navigation bar.

1. Review usage metrics.

The Usage page displays usage metrics for all model API keys in your organization. The page provides the following tabs:

• Usage Activity: Shows detailed usage metrics and charts for your organization.

• Free Usage: Shows free quota consumption by model.

To learn more, see [Usage Page Features.](https://www.mongodb.com/docs/voyageai/management/monitor-usage.md#std-label-voyage-usage-page-features

Usage Page Features

The Usage page provides several views that you can use to monitor and analyze your Voyage AI usage. The available features vary depending on whether you are viewing usage at the organization or project level.

Total Usage

In the Total Usage chart, you can view the total [tokens](https://www.mongodb.com/docs/voyageai/index.md#std-term-tokens used across your organization or project over time. You can filter usage data by using the following options:

You can also toggle between Tokens and Pixels to view usage measured in tokens processed or pixels processed (applies to multimodal models).

Additional Views

The Usage page also provides the following views to help you monitor and analyze your Voyage AI usage:

Usage by Geography

Atlas tags every request with the Geography that served it. You can filter your usage data by Geography and segment it by Geography to see how much of your usage each Geography accounts for.

To learn about Geographies and their endpoints, see [Geographies for Voyage AI Inference.](https://www.mongodb.com/docs/voyageai/geographies.md#std-label-voyage-geographies

Export and Billing

You can also use the Usage page to export usage data and access billing information: