Support
Home
Knowledge base
Stack Internal Community
Integrations

API usage metrics

How to retrieve your site's API usage data.

ADMIN PRIVILEGES REQUIRED

Applies to:
Free
Basic
Business
Enterprise

Overview

API usage metrics let administrators retrieve API call-volume data programmatically and understand how their organization consumes internal knowledge. Use these endpoints to monitor overall usage, compare API V2 and API V3 adoption, identify high-traffic applications, and build custom dashboards or recurring reports.

Metrics are returned monthly and are limited to the Community associated with the authenticated customer.

API reporting data began on July 22, 2026; reporting can't access data before that date. API reporting is available only in production environments (not UAT).

Available endpoints

Endpoint Description
/api/v3/metrics/api-call-volume Returns aggregate API call volume over time.
/api/v3/metrics/api-call-volume-by-application Returns API call volume grouped by application.

Both endpoints return total, API V2, and API V3 usage. API-version filtering isn't supported.

Aggregate API call volume

Use this endpoint to retrieve monthly API call volume across your Community.

GET /api/v3/metrics/api-call-volume

Query parameters

Parameter Required Description
startDate Yes First month in the reporting period, formatted as YYYY-MM.
endDate Yes Last month in the reporting period, formatted as YYYY-MM.
interval No Reporting interval. Metrics currently return monthly.

The reporting range is inclusive and can't exceed 60 months.

Example request

GET /api/v3/metrics/api-call-volume?startDate=2026-01&endDate=2026-06
Example response 
{
  "metricId": "api_call_volume",
  "period": {
    "startDate": "2026-01",
    "endDate": "2026-06",
    "interval": "month",
    "asOfDate": "2026-07-02T00:00:00Z"
  },
  "totals": {
    "allTime": {
      "totalCalls": 3183070,
      "v2": {
        "calls": 3180000,
        "sharePercent": 99.9
      },
      "v3": {
        "calls": 3070,
        "sharePercent": 0.1
      }
    },
    "selectedPeriod": {
      "totalCalls": 148190,
      "v2": {
        "calls": 145600,
        "sharePercent": 98.3
      },
      "v3": {
        "calls": 2590,
        "sharePercent": 1.7
      }
    }
  },
  "series": [
    {
      "period": "2026-01",
      "isPartialPeriod": false,
      "totalCalls": 24420,
      "v2": {
        "calls": 24000,
        "sharePercent": 98.3
      },
      "v3": {
        "calls": 420,
        "sharePercent": 1.7
      }
    },
    {
      "period": "2026-02",
      "isPartialPeriod": false,
      "totalCalls": 27460,
      "v2": {
        "calls": 27000,
        "sharePercent": 98.3
      },
      "v3": {
        "calls": 460,
        "sharePercent": 1.7
      }
    }
  ]
}

API call volume by application

Use this endpoint to identify the API applications or integrations generating traffic.

GET /api/v3/metrics/api-call-volume-by-application

Query parameters

Parameter Required Description
startDate Yes First month in the reporting period, formatted as YYYY-MM.
endDate Yes Last month in the reporting period, formatted as YYYY-MM.
clientId No Limits the response to a specific application.
interval No Reporting interval. Metrics currently return monthly.

Example request

GET /api/v3/metrics/api-call-volume-by-application?startDate=2026-01&endDate=2026-03

Retrieve metrics for one application

GET /api/v3/metrics/api-call-volume-by-application?startDate=2026-01&endDate=2026-03&clientId=315
Example response 
{
  "metricId": "api_call_volume_by_application",
  "period": {
    "startDate": "2026-01",
    "endDate": "2026-03",
    "interval": "month",
    "asOfDate": "2026-04-02T00:00:00Z"
  },
  "totals": {
    "allTime": {
      "totalCalls": 3183070,
      "v2": {
        "calls": 3180000,
        "sharePercent": 99.9
      },
      "v3": {
        "calls": 3070,
        "sharePercent": 0.1
      }
    },
    "selectedPeriod": {
      "totalCalls": 30070,
      "v2": {
        "calls": 30000,
        "sharePercent": 99.8
      },
      "v3": {
        "calls": 70,
        "sharePercent": 0.2
      }
    }
  },
  "applications": [
    {
      "clientId": 315,
      "clientName": "DX Portal",
      "totalCalls": 30070,
      "sharePercent": 100.0,
      "v2": {
        "calls": 30000,
        "sharePercent": 99.8
      },
      "v3": {
        "calls": 70,
        "sharePercent": 0.2
      },
      "series": [
        {
          "period": "2026-01",
          "isPartialPeriod": false,
          "totalCalls": 30070,
          "v2": {
            "calls": 30000,
            "sharePercent": 99.8
          },
          "v3": {
            "calls": 70,
            "sharePercent": 0.2
          }
        },
        {
          "period": "2026-02",
          "isPartialPeriod": false,
          "totalCalls": 0,
          "v2": {
            "calls": 0,
            "sharePercent": 0.0
          },
          "v3": {
            "calls": 0,
            "sharePercent": 0.0
          }
        }
      ]
    }
  ]
}

Response fields

Reporting period

Field Description
startDate First requested reporting month.
endDate Last requested reporting month.
interval Aggregation interval. Currently month.
asOfDate UTC timestamp that indicates how current the underlying metrics data is. It doesn't change the requested reporting range.

Totals

Field Description
totals.allTime Cumulative usage through the most recent available metrics data.
totals.selectedPeriod Usage within the requested inclusive date range.
totalCalls Combined API V2 and API V3 calls.
v2.calls Number of API V2 calls.
v2.sharePercent Percentage of the containing total generated through API V2.
v3.calls Number of API V3 calls.
v3.sharePercent Percentage of the containing total generated through API V3.

The API uses the following calculations:

  • totalCalls = v2.calls + v3.calls
  • sharePercent = version calls / totalCalls * 100

When totalCalls is zero, both version percentages return as 0.0.

Monthly series

Field Description
period Reporting month in YYYY-MM format.
isPartialPeriod Indicates that the month contains only partial data.
totalCalls Combined call volume for the month.
v2 API V2 call count and share for the month.
v3 API V3 call count and share for the month.

Every month in the requested range is included. A month with no recorded usage returns zero call counts and 0.0 percentages rather than being omitted.

Application fields

Field Description
clientId Identifier of the API application.
clientName Display name of the API application.
totalCalls Calls generated by the application during the selected period.
sharePercent The application's percentage of total Community API calls during the selected period.
v2 API V2 calls and their share of the application's usage.
v3 API V3 calls and their share of the application's usage.
series Monthly usage for the application.

Applications that can't be resolved to current application metadata use a stable fallback identity rather than being excluded.

Data interpretation

  • asOfDate describes data freshness, not the end of the requested reporting period.
  • isPartialPeriod: true indicates that additional calls might be added as metrics processing continues.
  • allTime totals might contain usage outside the requested range.
  • selectedPeriod totals cover only the requested range.
  • Application totals reconcile with the aggregate endpoint for the same reporting period, subject to documented exclusions or percentage rounding.
  • Percentages might not add up to exactly 100.0 because of rounding.
https://doc-automation.netlify.app/pdfs/docs/community/enterprise/for_admins/integrations/API_usage_metrics.pdf

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Author
Joel Bradley
Tags
API Usage metrics
Download as PDF
Preview
0 of 0