Introduction
Once your apps start calling RecordsKeeper.AI, the API Key Details view becomes your control room. It brings together high-level trends (success/failure and response time) with request-level logs so you can investigate issues in seconds - no digging through server logs. You’ll also find the key’s ownership and lifecycle information on the same screen.
Navigate to API Key Details
Go to Widgets & Integration → API & Integration.
Open the API Keys tab and click any key’s Name to view its details.
Use the tabs inside the page:
Overview - health and performance charts + key metadata.
API Log - live request timeline and per-request inspector.
A top-right Edit button is available for updating the key’s name/description/expiry (secret values are never exposed).
Overview tab - understand health at a glance
Event Deliveries (Successful vs Failed): Shows how many requests for this key succeeded or failed over time (daily/weekly picker). Use it to spot spikes in failures after a deployment or config change.
Event Response Time (Min / Avg / Max): Track latency trends to identify slow endpoints or network issues.
API Key Details (side panel):
Created By / Created On / Updated On - ownership and audit trail.
API Key - masked value for identification (secrets are not viewable).
Note: Keys can’t be recreated from this page. If the secret is lost, create a new key and rotate your integration.
API Log tab - drill down to a single request
The bottom left timeline lists recent requests for this key. Each row shows status badge (e.g., 200 OK, 400 Error, 404 Not Found), method, endpoint, and timestamp (grouped by Today/Yesterday).
Click any row to open the Request Inspector on the right. You’ll see:
Method & Endpoint - the exact route called.
Status - HTTP result.
Request ID - unique ID for tracing with your logs.
API Key ID - the internal identifier of the key used.
Latency - server time to handle the call.
IP Address & Origin - where the call came from.
User Agent - client info (library/browser).
Calling Location & Device - geo/device hints to help spot misuse.
Request body / Response body - expandable sections with payload details for quick debugging.
Use Search, Filter, and Pagination to narrow down results when investigating.
Typical workflows
1) A spike in failures after a release
Open Overview → Event Deliveries and confirm the spike window.
Switch to API Log, filter to the timeframe, and open a few failed entries.
Check status code and response body for the error (e.g., validation failure).
Fix your client payload or permissions, then re-test.
2) Latency increased
Compare Avg and Max in Event Response Time.
Inspect slow requests; look at endpoint patterns, origin, and response body for hints (e.g., large queries or file uploads).
Optimize your app’s calls, batch when possible, or move heavy work off the request path.
3) Possible misuse or leaked credentials
In API Log, scan Origin/IP and Location/Device for unexpected sources.
Toggle the key off from the API Keys list to halt traffic.
Create a new key, update your application, then delete the old key.
Using keys optimally (practical guidance)
One key per integration & environment (e.g., “CRM - Prod”, “CRM - Staging”) to isolate risk and simplify rotation.
Name & describe clearly so teammates know what can be safely disabled.
Set an expiry for temporary vendors or pilots; renew intentionally.
Rotate on a schedule: create a new key → update your app → disable/delete the old one.
Store secrets in a vault, not in code, chat, or email.
Monitor “Last Used” on the keys list to find stale credentials you can retire.
Use the logs first when debugging - request/response bodies and Request IDs will cut your time to fix dramatically.
Conclusion
The API Key Details view combines metrics and forensic logs so you can spot issues early, validate fixes, and keep access tight. Use the Overview to watch trends, the API Log to investigate specific calls, and the keys list to rotate or revoke access confidently. With a clear naming scheme and regular reviews, your API integrations will stay fast, secure, and easy to maintain.