Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

The Overview tab is your command center for monitoring API usage, tracking performance, and understanding your account status.

Quick Stats

The dashboard displays four key metrics at the top:

Monthly Requests

  • What it shows: Total API requests made in the current billing period

  • Trend indicator: Shows percentage change compared to last month

    • ↑ Green = Increase

    • ↓ Red = Decrease

    • → Gray = No change

  • Use case: Monitor your API usage patterns and growth

Remaining Quota

  • What it shows: Number of requests remaining in your current plan

  • Display: Shows actual number or ♾️ for unlimited plans

  • Alert: Keep an eye on this to avoid hitting your limit

  • Action: Upgrade your plan if you're consistently hitting limits

Success Rate

  • What it shows: Percentage of successful API requests

  • Calculation: (Successful requests / Total requests) × 100

  • Healthy range: 95% or higher is excellent

  • Status indicator: "Operational" when performing well

  • Troubleshooting: Low success rate may indicate API key issues or invalid requests

Whitelist Limit

  • What it shows: Percentage of IP whitelist slots used

  • Details: Shows "X / Y IPs used" (e.g., "3 / 50 IPs used")

  • Plan-based: Limit varies by subscription tier

  • Action: Remove unused IPs or upgrade for more slots

Current Plan

Located in the top-right corner of the dashboard:

  • Plan Badge: Displays your current subscription tier

    • Free Tier

    • Pro Monthly

    • Pro Yearly

    • Custom plans

Monthly Activity Table

Detailed breakdown of your API usage over the last 12 months.

Columns Explained

Column
Description

Period

Month and year (e.g., "January 2026")

Total Requests

All API calls made in that month

Success

Number of successful requests (2xx responses)

Failure

Number of failed requests (4xx, 5xx responses)

Status

Success rate badge with percentage

Understanding the Data

Success Rate Badge Colors:

  • 🟢 Green (95-100%): Excellent performance

  • 🟡 Yellow (80-94%): Good, but room for improvement

  • 🔴 Red (<80%): Needs attention Common Patterns:

  • Steady growth: Increasing requests month-over-month

  • Seasonal spikes: Higher usage during specific months

  • Sudden drops: May indicate integration issues or service changes

Navigation

Use the sidebar to access different sections:

Console Sections

  • Overview (current page) - Usage statistics and metrics

  • API Keys - Manage authentication credentials

  • Team - Invite and manage organization members

  • Roles - Configure custom permissions

  • Whitelist - Control IP access

  • Settings - Account security and preferences

  • Billing - Subscription and payment management

  • Whois Lookup - IP intelligence tool

Additional Links

  • Logout - Sign out of your account

Understanding Your Usage

Billing Period

Your usage metrics are calculated based on your billing cycle:

  • Free Tier: Calendar month (resets on the 1st)

  • Paid Plans: Subscription period (e.g., from signup date)

Quota Management

When approaching your limit:

  1. Monitor regularly: Check the "Remaining Quota" card

  2. Optimize usage: Review which endpoints consume most requests

  3. Consider upgrading: Switch to a higher tier if needed

  4. Whitelist optimization: Remove unused IP addresses

What happens when quota is exceeded:

  • API requests will be blocked

Success Rate Optimization

If your success rate is low:

  1. Check API keys: Ensure they're active and have correct permissions

  2. Review request format: Validate request parameters

  3. Check IP whitelist: Ensure your IPs are whitelisted if required

  4. Monitor error codes: Use logs to identify specific issues

  5. Contact support: If issues persist

Best Practices

Regular Monitoring

  • Daily: Quick glance at success rate

  • Weekly: Review request trends

  • Monthly: Analyze full activity table before billing cycle ends

Proactive Management

  • Plan ahead: Upgrade before hitting limits

  • Clean up: Remove unused API keys and whitelisted IPs

Team Collaboration

  • Assign roles: Give team members appropriate access levels

  • Review together: Monthly usage reviews help optimize costs

Quick Actions

From the Overview page, you can quickly:

  1. Navigate to any section - Use the sidebar menu

  2. Monitor trends - Review the monthly activity table

  3. Assess health - Glance at the four stat cards

Next Steps

  • Create an API Key to start making requests

  • Set up IP Whitelist for additional security

  • Invite team members to collaborate

  • Configure billing to upgrade your plan

PreviousAuthenticationNextAPI Keys

Last updated