Request Tracking
MindKey tracks API requests to provide usage insights and enable troubleshooting. You can enhance this tracking by sending optional HTTP headers with your requests.
Integration-ID
The Integration API supports two headers for identifying your integration:
| Header | Description |
|---|---|
X-Integration-Id | Primary header for integration identification |
X-MindKey-IntegrationId | Alternative header (used if X-Integration-Id is not present) |
POST /api/{customerId}/Employees/find HTTP/1.1
X-MindKey-IntegrationId: my-payroll-sync
- Maximum length: 100 characters
- If not provided, requests are grouped as unidentified
- MindKey automatically creates an integration entry in your database when a new ID is first seen
- Usage breakdowns per integration are visible in the MindKey API Usage dashboard
Use a descriptive, stable identifier for each integration (e.g. payroll-export, timetracking-sync). This makes it easier to track which integration is responsible for specific API traffic.
Batch ID
Use the X-MindKey-BatchId header to group related requests into a batch. This is useful for correlating requests that belong to the same synchronization run or data export.
POST /api/{customerId}/Employees/find HTTP/1.1
X-MindKey-IntegrationId: my-payroll-sync
X-MindKey-BatchId: 2026-03-30-daily-sync
The batch ID appears in Application Insights traces, helping with troubleshooting.
Distributed Tracing
MindKey supports W3C Trace Context for distributed tracing. Send the traceparent header to correlate API calls with your own application traces.
POST /api/{customerId}/Employees/find HTTP/1.1
traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
The traceparent header format follows the W3C specification:
{version}-{trace-id}-{parent-id}-{trace-flags}
| Field | Format | Description |
|---|---|---|
| version | 00 | W3C spec version |
| trace-id | 32 hex characters | Unique identifier for the entire trace |
| parent-id | 16 hex characters | Identifier for the current span |
| trace-flags | 01 | Sampled flag |
Distributed tracing propagation is available on the Enterprise plan with W3C Trace observability level. On other plans, the header is accepted but trace context is not propagated.
API Usage Dashboard
Your API usage is visible in the MindKey application under Administration > Integration > API Usage. The dashboard shows:
- Current plan and limits
- Daily request counts with a 30-day history chart
- Per-integration and per-entity breakdowns (when using integration ID headers)
- API availability monitoring