Retrieve comprehensive usage statistics, quota information, and time-series data for your API key.
Essential for monitoring consumption, planning capacity, and managing costs.

Usage Notes

• Returns CU (Compute Unit) consumption metrics
• Provides time-series data for trend analysis
• Includes subscription tier and quota information
• Data is updated in near real-time (1-2 minute delay)
• Historical data retained based on your subscription tier
• Time range limited to 1 year maximum
• Default time range: current billing cycle

Accessibility

Tier Access: All tiers

Compute Unit Cost: 0 CU per request

Time Range Parameters

• startTime and endTime are Unix timestamps in seconds
• If not provided, startTime defaults to the start of the current billing cycle
• If not provided, endTime defaults to the current time
• Maximum time range: 1 year (365 days)
• For accurate billing analysis, align with your billing cycle dates

Granularity Options

Hour Granularity

• Best for: Real-time monitoring, spike detection, hourly analysis
• Recommended range: Up to 7 days
• Data points: Up to 168 per week

Day Granularity (Default)

• Best for: Monthly reports, trend analysis, capacity planning
• Recommended range: 30-90 days
• Data points: Up to 365 per year

Common Use Cases

• Monitor real-time API consumption
• Track CU usage against quota limits
• Generate usage reports for accounting
• Identify usage spikes and patterns
• Plan subscription tier upgrades
• Forecast monthly costs
• Detect unusual activity or abuse
• Optimize API call patterns
• Build internal usage dashboards
• Implement usage-based alerts

Best Practices

• Cache usage data to avoid excessive API calls
• Use day granularity for reports, hour granularity for monitoring
• Set up alerts when approaching quota limits
• Review usage patterns regularly to optimize costs
• Archive historical usage data for compliance
• Compare usage across billing cycles to identify trends
• Use overage data to plan tier upgrades

Understanding the Response

Subscription Info: Your plan type, tier, and billing cycle dates

Quota Info: Total CU allocation, used CU, remaining CU, and overage

Period Usage: Aggregated metrics for the requested time range

Data Points: Time-series array with CU and request counts per time bucket

Quota Management

• Monthly subscriptions: Quota resets at the start of each billing cycle
• Prepaid subscriptions: Fixed quota that doesn't reset
• Overage: CU consumed beyond your quota (may incur additional charges)
• Remaining: CU available before hitting quota limit