DOCS

API usage

API usage

Monitor your organization's API call volume and usage by product, and export your usage history to CSV.

The Usage page in Dashboard shows how your organization is using the Zonos API over time. You can see your total call volume, which products you use most, and how usage trends month over month—then export the underlying data to a CSV file for reconciliation, billing review, or deeper analysis.

To open it, log in to Dashboard and select Usage in the left navigation.

Reading the dashboard 

At the top of the page, two cards summarize your activity for the selected period:

  • Total API calls — The total number of API calls in the selected period. When you view monthly granularity, this card also shows the percent change compared to the previous month.
  • Most used API — The Zonos product you call most often.

Below the cards, the API volume chart plots your calls over time as a stacked bar chart, color-coded by product. The API type breakdown beneath it lists each product with its call count and its share of total usage.

Use the controls above the chart to adjust the view:

  • Date range — Choose 1 month, 3 months, or 6 months.
  • Granularity — Group activity by Daily, Weekly, or Monthly buckets.

Which API products are tracked 

Usage is reported per Zonos product so you can see exactly where your calls are going:

ProductDescription
ClassifyHS code classification requests
Landed CostDuty, tax, and fee calculation requests
Order CompleteOrders completed through the Zonos API
Denied PartyDenied party (Screen) screening requests
Restricted ItemItem restriction (Restrict) checks

Export your usage to CSV 

To download a CSV of your usage history:

  1. On the Usage page, click Export.
  2. In the Download API usage CSV dialog, choose a Date range. Select a preset—This month, Last month, Last 7 days, Last 30 days, Last 90 days, This quarter, Last quarter, Year to date, or Last year—or pick Custom and set your own Start date and End date.
  3. Under API types, select which products to include. All supported products are selected by default.
  4. Choose a GranularityDaily, Weekly, or Monthly—to control how rows are grouped by date.
  5. Click Download.

The dialog opens pre-filled with the date range and granularity currently shown on the page, so you can export what you're viewing in one click.

The exported file contains the following columns:

ColumnDescription
PeriodThe date bucket for the row, based on the selected granularity
API TypeThe Zonos product the calls belong to
Call CountThe number of API calls for that product in that period

Note: If no usage matches the selected filters, no file is downloaded and Dashboard lets you know there was nothing to export. Try widening the date range or selecting more API types.

Usage data migration notice 

Zonos recently migrated to an improved API usage tracking system. Usage data from before the migration may be incomplete or missing—this is expected. All usage going forward is tracked accurately.

Book a demo

Was this page helpful?