Usage Tracking

Wictz API provides comprehensive tools for tracking your API usage, monitoring costs, and analyzing performance. This information is primarily available through your Wictz API dashboard.

Dashboard Metrics

Your Wictz API dashboard offers a variety of metrics and visualizations to help you understand your API consumption:

• Request Volume: Track the total number of API requests made, filterable by date range, provider, model, and API key. View trends over time (daily, weekly, monthly).
• Token Usage: For language models, monitor the number of prompt tokens and completion tokens processed. This is often broken down by model.
• Cost Analysis: See an estimate of your spending, broken down by provider, model, and time period. This helps in managing your budget effectively. (Note: Final billing is based on your subscription plan and official invoices).
• Error Rates & Analysis: Track the percentage of failed requests and view details of common errors. This can help identify integration issues or patterns of rate limiting.
• Latency/Response Times: View average and percentile response times for your API calls, which can help in performance optimization.
• Active API Keys: See usage statistics per API key, useful for identifying which applications or services are consuming the most resources.

Usage Alerts

Wictz API offers a notification system to help you stay informed about your usage and avoid unexpected overages or service disruptions. You can typically configure alerts for:

• Approaching Quota/Limit Thresholds: Get notified when your usage (e.g., requests, tokens, or cost) reaches a certain percentage (e.g., 80%, 90%) of your plan's limits or a custom budget you set.
• Limit Exceeded: Receive immediate alerts when a rate limit or quota is hit.
• Low Credits (for pre-paid plans): If your plan involves pre-paid credits, get warnings when your credit balance is running low.

Alerts can usually be configured for delivery via email or through notifications within the Wictz API dashboard. Check your account settings for notification preferences.

Exporting Usage Data

For more detailed analysis or record-keeping, Wictz API typically allows you to export your usage data. Common export options include:

• CSV/Excel Exports: Download raw request logs or summarized usage reports in standard formats.
• Date Range Filtering: Specify custom date ranges for the data you want to export.
• Data Points: Exported data often includes timestamps, API key used, provider, model, endpoint, status code, request/completion tokens, latency, etc.

Programmatic Usage Access (API Endpoint)

For automated monitoring or integration with your own systems, Wictz API may provide an endpoint to fetch usage data programmatically. A common pattern for such an endpoint would be:

curl -X GET "https://wictz.com/api/user/usage?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&granularity=daily" \
  -H "Authorization: Bearer YOUR_API_KEY"

The exact endpoint, parameters (like start_date, end_date, granularity, model_id), and response structure would be detailed in specific API documentation for this feature if available. The response would typically be JSON formatted.

By leveraging these usage tracking tools, you can effectively manage your API consumption, optimize costs, and ensure your applications run smoothly within the defined limits.