Diagnosing a Failed Request

When a request to the Integration API fails, or does something you didn't expect, the Request Log API shows you what Everee received and what it answered. This guide walks through the common ways to use it. It covers calls to /integration/v1 made in the last 30 days.

All the examples use your API token and tenant ID, as described in Authentication & API tokens:

authorization: basic c2tf...
x-everee-tenant-id: 12345

Find a call by its request ID

Every response includes an X-Request-ID header. If you logged it, or a user reported it, look the call up directly:

GET /integration/v1/api-calls?request-id=3c1f9d5e-6a7b-4b52-9d8e-2e4c8a1b7f90

The entry tells you the status, the errorMessage for failures, which apiKeyId made the call, and how long it took (durationMs). Take its id and call Get a request log entry for the rest.

If you don't have a request ID, find the call by time and what was called instead:

GET /integration/v1/api-calls?status-class=FAILED&path=/integration/v1/workers&from=2026-10-27T00:00:00Z

See what was sent and what came back

Get a request log entry returns the stored request and, for failures, the error response:

• requestBody is the body Everee received. Compare it with what you meant to send. A missing field, a wrong type, or an unexpected format is usually visible straight away.
• responseBody is the error response, including errorMessage, which describes what to change.
• requestHeaders includes the content-type and accept you actually sent. See Requests & responses.

Sensitive values, such as Social Security numbers, bank account numbers, and dates of birth, are masked, and appear as <<REDACTED:/path/to/field>>. redactedFields lists where. You can't see the value, but you can see that the field was sent. If a call fails because of one of those values, check it in your own logs.

Check which credential made a call

Each entry has an apiKeyId. If a call came from an integration you didn't expect, or after a token was rotated, filter by it to see everything that token has done:

GET /integration/v1/api-calls?api-key-id=ak_rnzFPOQBG2nyAJQy

Find what you're still sending that's deprecated

Before something is removed from the API, find out whether you're still using it:

1. List calls that used anything deprecated: GET /integration/v1/api-calls?uses-deprecated=true
2. Get one of the entries. Its deprecatedUsages names each thing, such as BODY_FIELD:/dimensions.
3. To find every call that used the same thing, list with deprecated-usage=BODY_FIELD:/dimensions.

The log records the names of what was used, never the values. See the Request Log guide for what it can and can't see.

Common mistakes

• Looking for calls outside /integration/v1. Other paths aren't recorded. Neither are calls turned away for being unauthenticated or rate limited (429).
• Expecting a successful response body. Only error responses are stored.
• Expecting unmasked values. Sensitive fields are always masked.
• Looking back more than 30 days. Older entries are gone.

Next steps

• Guide to the Request Log API
• Requests & responses
• Rate limits