Skip to main content

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​

Use the X-Integration-Id header to identify your integration. This allows you to see per-integration usage breakdowns in the MindKey API Usage dashboard.

GET /odata/v2/Employee HTTP/1.1
Authorization: ApiKey your-api-key
X-Integration-Id: 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
tip

Use a descriptive, stable identifier for each integration (e.g. my-payroll-sync, hr-dashboard-export). This makes it easier to identify which integration is responsible for specific API traffic.

Distributed Tracing​

MindKey supports W3C Trace Context for distributed tracing. If your integration sends the traceparent header, MindKey will propagate the trace context, allowing you to correlate API calls with your own application traces.

GET /odata/v2/Employee HTTP/1.1
Authorization: ApiKey your-api-key
traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01

The traceparent header format follows the W3C specification:

{version}-{trace-id}-{parent-id}-{trace-flags}
FieldFormatDescription
version00W3C spec version
trace-id32 hex charactersUnique identifier for the entire trace
parent-id16 hex charactersIdentifier for the current span
trace-flags01Sampled flag
info

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 Access > 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 X-Integration-Id)
  • API availability monitoring