---
schema_version: "1"
id: 023e1e2c47de56c6adc5a5119c790411ba033dc8e2f9da432fec9d6f3a4760e3
title: Usage Reports
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/general/usage-reports.md
canonical_url: https://docs.mulesoft.com/general/usage-reports
source_site: docs.mulesoft.com
content_type: documentation
content_hash: a7ce3908b2e1a933b68c9fd4e481bc2287ac3404f1f7e20dd2422dac7df60e8e
description: MuleSoft Documentation Site
latest: true
---
---
product: Getting Started
keywords: usage reports, mule runtime, product consumption, anypoint platform, runtime versions, monitoring, access reports
---

# Usage Reports

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Usage reports provide comprehensive monthly and daily summaries that give you valuable insights into
your resource use across Anypoint Platform products. By correlating your usage with billing cycles,
you can gain insights into the factors influencing your costs. This enables you to proactively
manage your budget and make informed decisions to optimize your resource allocation.

When you use an Anypoint Platform product that is metered, MuleSoft measures your usage and
aggregates the records on a daily and monthly basis.

Usage report data is refreshed twice a day. The most recent three days of data is subject to change.
For example, on January 10, data from January 7 to January 10 might still be updated. Data from
January 6 and earlier is final and won’t change.

All reports are calculated using the UTC time standard. For example, a daily usage is aggregated
from 00:00 to 00:00 UTC.

Daily usage retention is three months and monthly usage retention is up to five years.

Organizations that have a usage-based pricing model can compare actual usage from the report against
the existing contract. However, usage reports are not for billing purposes. For more information
about usage metrics and pricing, read [Anypoint Platform Pricing](https://docs.mulesoft.com/general/pricing) and
[Usage-Based Pricing: Usage and Rates](https://docs.mulesoft.com/general/usage-metrics)

Some usage data, such as monthly statements and vCore allocation, appears in different areas of
Anypoint Platform or Salesforce products.

- Monthly statements for Mule runtime, including Mule flows, Mule messages, and data throughput are
  sent to the primary billing contact.

  [Automation credits](https://docs.mulesoft.com/general/automation-credits-usage-and-rates) for RPA, Composer, Intelligent Document
  Processing (IDP), Salesforce Flow Orchestration, and MuleSoft for Flow are sent to the primary
  billing contact.

  For more information, see
  [Monthly Account Summaries](https://help.salesforce.com/s/articleView?id=000390885&type=1)
  documentation in Salesforce.

- Usage of certain Salesforce generative AI features (Agentforce and Einstein generative AI) or
  direct calls to the large language model (LLM) gateway consumes credits. All Salesforce AI usage
  from Anypoint Platform features is routed through your connected Salesforce org, which tracks
  consumption and handles billing.

  Anypoint Platform features that use Einstein generative AI or Agentforce features include:

  - Anypoint Code Builder

    Use MuleSoft Dev Agent to develop integrations and API specs.

    For more information about this feature, see
    [Developing Integrations Using MuleSoft Vibes](https://docs.mulesoft.com/anypoint-code-builder/int-ai-developing-integrations)
    and [MuleSoft Vibes Overview](https://docs.mulesoft.com/anypoint-code-builder/mulesoft-vibes).

  - Intelligent Document Processing (IDP)

    Use Einstein generative AI to read and interpret documents.

    For more information about this feature, see
    [Enhancing Data Extraction with Einstein](https://docs.mulesoft.com/idp/enhancing-data-extraction-with-einstein)..

  - Anypoint Exchange

    Use Einstein generative AI to generate API documentation for REST APIs.

    For more information about this feature, see
    [Generating API Documentation with Generative AI](https://docs.mulesoft.com/exchange/generating-documentation-with-ai).

    For more information about how the usage for these features is tracked and billed, see
    [Agentforce and Generative AI Usage and Billing](https://help.salesforce.com/s/articleView?id=ai.generative_ai_usage.htm&type=5).

- Alerts for usage reaching 80% and 90% of the contractual entitlement are sent automatically to the
  primary billing contact email address. The primary billing contact gets alerts monthly once
  thresholds are reached.

  For more information, see the
  [Salesforce Usage Alerts FAQ](https://help.salesforce.com/s/articleView?id=004811177&type=1)
  knowledge article.

- CloudHub vCore consumption data, including peak usage across CloudHub (CH1) and CloudHub 2.0
  (CH2), is available in Usage Reports.

  For more information, see [CloudHub vCore Usage](https://docs.mulesoft.com/general/usage-metrics#cloudhub-vcore-usage).

Government Cloud and Anypoint Private Cloud Edition usages aren’t available in usage reports.

## Products Available in Usage Reports

The following products are available in usage reports:

- Anypoint MQ

- API Experience Hub

- API Governance

- API Manager

- [CloudHub vCore](https://docs.mulesoft.com/general/usage-metrics#cloudhub-vcore-usage)

- Omni Gateway

- Omni Gateway Model Proxy

- Intelligent Document Processing (IDP)

- Mule Runtime

- Object Store v2

## Supported Mule Runtime Versions

To view usage reports for Mule runtime, all applications (in production and sandbox) must use these
Mule versions:

<table><colgroup><col> <col></colgroup><thead><tr><th>Deployment Type</th><th>Version Requirements</th></tr></thead><tbody><tr><td><p>CloudHub 2.0</p></td><td><p>The latest date-patch versions for 4.3.0 and later</p></td></tr><tr><td><p>CloudHub</p></td><td><p>The latest date-patch versions for 3.9 and 4.2.0 and later</p></td></tr><tr><td><p>Runtime Fabric</p></td><td><div><div><p>One of these versions or any later date-patch:</p></div><div><p>Mule 4 image versions:</p></div><div><ul><li><p>4.5.0 and later</p></li><li><p>4.4.0-20230111-1</p></li><li><p>4.3.0-20221212-2</p></li><li><p>4.2.2-20221027-7</p></li><li><p>4.2.1-20221027-7</p></li><li><p>4.2.0-20221027-6</p></li></ul></div></div></td></tr><tr><td><p>Hybrid Standalone</p></td><td><div><div><p>One of these versions or any later date-patch:</p></div><div><ul><li><p>4.6.0 and later</p></li><li><p>4.4.0-20221111</p></li><li><p>4.3.0-20221024</p></li></ul></div><div><p>Runtime Manager Agent 2.7.0 and later</p></div></div></td></tr></tbody></table>

You must redeploy your apps with a supported version, either manually or during the monthly patching
cycle. The monthly patching cycle is applicable only for CloudHub and CloudHub 2.0 applications.

You can [roll back](https://docs.mulesoft.com/cloudhub-2/ch2-update-apps#roll-back-to-a-previous-successful-configuration)
to a previous successful application configuration. However, if an app is using a Mule version not
supported by usage reports, you must choose a compliant Mule version before deploying changes. After
deployment, a new configuration with the previously chosen settings and a supported runtime is
created.

## Before You Begin

Usage reports are available only when you’re signed in to the root organization and don’t appear at
the business group level.

To access usage reports, you need the
[Usage Viewer permission](https://docs.mulesoft.com/access-management/permissions-by-product#usage). If you don’t have this
permission, contact your organization administrator to request access. The Usage Viewer permission
must be [applied at the root organization level](https://docs.mulesoft.com/access-management/managing-permissions) rather
than the business group level.

## Access Usage Reports

1.  Sign in to Anypoint Platform using an account that has the Usage Viewer permission for your root
    organization.

2.  In the Anypoint Platform navigation bar, click the business group selector, and ensure you are
    at the root organization level.

3.  In the Anypoint Platform navigation bar, click your username icon and select **Usage Reports**.

4.  Select the product for which to view a usage report.

5.  Click **Monthly Usage Report** or **Daily Usage Report**.

6.  Select the month or day of the usage report to view. For the selected product, only dates that
    Anypoint Platform collected data for are available.

    The usage report appears, displaying an assortment of usage metrics that are
    [dependent on the product you selected](https://docs.mulesoft.com/general/usage-metrics).

## Export Usage Reports to a CSV File

You can export both daily and monthly usage reports to CSV files. These metrics match the data
available in usage reports.

1.  Navigate to the usage report to download.

2.  Click **Export as CSV**.

## Usage API

Use the Anypoint Usage API to programmatically access usage data. The API provides both daily and
monthly details. Usage metrics are organized by business group and application. This provides
detailed insight into product consumption.

To use the API, see the API documentation for the
[Anypoint Usage API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a/usage-api/)
for access and implementation details. Users must have Usage Viewer permission to access the Usage
API.

For a summary of pricing models and where to review usage and billing context for each model, see
[Usage-Based Pricing: Usage and Rates](https://docs.mulesoft.com/general/usage-metrics).

## Granular Mule Credits Visibility

Anypoint Usage Reports provide operational drill-down visibility for Mule Credits-related
consumption.

> [!NOTE] Use Salesforce Digital Wallet for finalized, billing-relevant Mule Credits totals and
> statements.

For detailed Mule Credits usage guidance and billing context, see
[Understand Mule Credits Usage and Rates](https://docs.mulesoft.com/general/mule-credits-usage-and-rates).

## Usage Reports on Control Planes

All features of Usage Reports are supported on Japan and Canada control planes.

## See Also

- [Anypoint API Governance Overview](https://docs.mulesoft.com/api-governance/)

- [API Manager 2.x](https://docs.mulesoft.com/api-manager/latest/)
