Skip to content
This documentation is currently in preview, therefore subject to change.

View Usage Reports

Overview

The Build a Doc portal provides usage reports to help you monitor API consumption and plan capacity.


Accessing Usage Reports

  1. Sign in to the Build a Doc portal
  2. Navigate to Usage or Reports
  3. View your consumption metrics

Available Metrics

Document Actions

  • Total document generations
  • Breakdown by action type (Convert Word, Convert Excel, etc.)
  • Daily/weekly/monthly trends

Utility Actions

  • Compute data operations
  • Chart rendering
  • Other utility calls

Quota Status

  • Current usage vs. plan limit
  • Percentage consumed
  • Days remaining in billing cycle

Report Time Periods

PeriodDescription
TodayCurrent day usage
This WeekCurrent week (Monday-Sunday)
This MonthCurrent billing month
Custom RangeSelect specific dates

Peak Usage

Identify when your heaviest usage occurs:

  • Time of day
  • Day of week
  • Specific workflows

Monitor usage growth over time:

  • Month-over-month comparison
  • Predict when you might need to upgrade

Exporting Reports

TBD


Setting Up Alerts

TBD