API Key Usage
Monitor and analyze your API key usage to track integration activity, identify trends, and troubleshoot issues.
Accessing API Key Usage
From the sidebar, expand Integrations and click API Keys. You'll see a list of all your API keys with their descriptions and last used timestamps. Each API key row includes action buttons for viewing usage statistics (chart icon), copying the key, and deleting the key.
To view detailed usage statistics for a specific API key, click the chart icon in the Actions column. This opens the API Key Usage dashboard for that particular key.
Usage Dashboard Overview
The API Key Usage dashboard provides comprehensive analytics for your API key activity. At the top of the page, you'll see the API key name and a "Back to API Keys" link to return to the main API Keys list.
Summary Metrics
The dashboard displays four key metrics in card format:
Total Requests
Shows the total number of API calls made using this key. This includes all requests regardless of their outcome.
Completed
Displays the count of successfully processed requests (shown in green). These are requests that received a valid response from the API.
Failed
Indicates the number of requests that encountered errors (shown in red). This helps identify potential issues with your integration.
Rate Limited
Shows requests that were rejected due to exceeding the rate limit (shown in orange). If this number is high, consider optimizing your request frequency or contacting support for rate limit adjustments.
Analytics Charts
The dashboard includes three visualization sections to help you understand your API usage patterns:
By HTTP Method
Presents a donut chart breaking down requests by HTTP method (GET, POST, etc.). This helps you understand the types of operations your integration performs most frequently.
By Response Status
Shows a donut chart categorizing requests by HTTP response codes. Common status codes include 200 (success), 429 (rate limited), and 503 (service unavailable). This visualization helps quickly identify if your integration is experiencing issues.
Top Endpoints
Lists the most frequently called API endpoints with their request counts. This helps identify which parts of the API your integration uses most heavily and can guide optimization efforts.
Request Log
Below the analytics section, you'll find a detailed request log table that shows individual API requests. The table includes the following columns:
Filtering Requests
The request log supports multiple filtering options to help you find specific requests:
Click Apply to apply your selected filters, or Clear filters to reset all filters. You can also use Edit columns to customize which columns are displayed in the table.
Managing API Keys
From the main API Keys page, you can perform the following actions:
Generate API Key
Creates a new API key for your workspace. Click the blue "Generate API Key" button in the top right corner. Give your key a descriptive name to help identify its purpose (e.g., "PowerAutomate", "Zapier Integration").
Delete API Key
Permanently removes the API key. This action cannot be undone, and any integrations using this key will stop working immediately.
Why Use Multiple API Keys
A single API key works across all agents and postings in your workspace, but creating multiple keys gives you better control over monitoring, security, and troubleshooting — especially useful for staffing agencies managing multiple clients or integrations.
Environment Separation
Create separate keys for production and staging/development environments. This isolates traffic and makes it easier to troubleshoot issues without affecting live integrations.
Usage Tracking per Integration
Each API key tracks its own usage metrics including requests, success/failure rates, and endpoint activity. Create separate keys for different integrations (e.g., "ATS Integration", "Webhook Service", "Candidate Ingestion") to monitor each one independently.
Security & Access Control
Revocation granularity: If one key is compromised, revoke just that key without affecting other integrations
Key rotation: Rotate keys for specific integrations without disrupting all services
Team access: Different team members or external partners can use different keys
Rate Limiting Isolation
Using separate keys for different services prevents one high-traffic integration from consuming the rate limit for others.
Audit & Debugging
Since usage logs are tracked per key, having separate keys makes it easier to:
Debug issues with specific integrations
Audit which system made which API calls
Track down errors to specific services
For Staffing Agencies: Consider creating separate API keys per client or per integration type. This makes it easy to track usage, troubleshoot issues, and revoke access if a client relationship ends.
Best Practices
When managing your API keys, consider the following recommendations:
Use descriptive names for your API keys that indicate their purpose or the integration they're used for. This makes it easier to manage multiple keys and identify which key is used where.
Regularly review your API key usage to identify unused keys that can be deleted, reducing security risk.
Monitor the Failed and Rate Limited metrics to catch integration issues early. A sudden spike in failed requests may indicate a problem with your integration or changes to the API.
If you're consistently hitting rate limits, review your integration logic to reduce unnecessary API calls or implement request batching where possible.
Keep your API keys secure and never share them in public repositories or client-side code. If you suspect a key has been compromised, delete it immediately and generate a new one.
Last updated