API request logs
Look up the API calls your Account made, with status, path and payload, to debug a failed request.
An API request log is a record of one inbound call to the Wingspan API made by your Account. Use it to find out why an upload failed, which field was missing, or which call returned an error, without asking engineering. To see how a resource changed over time, use Audit logs instead.
Prerequisites
- A credential with the
platform.api-request-log:readscope.
Endpoints
| Purpose | Method and path |
|---|---|
| List API request logs | GET /v3/platform/api-request-logs |
| Get an API request log entry | GET /v3/platform/api-request-logs/{logId} |
Find a failed call
All filters are exact matches or a time range.
| Filter | Type |
|---|---|
filter[status][eq] | Integer HTTP status, such as 422 |
filter[method][eq] | GET, POST, PATCH, PUT or DELETE |
filter[path][eq] | Request path |
filter[accountId][eq] | Account ID |
filter[apiKeyId][eq] | API key ID |
filter[from][eq], filter[to][eq] | Date-time bounds |
curl -g "https://api.wingspan.app/v3/platform/api-request-logs?filter[status][eq]=422&filter[method][eq]=POST&page[size]=25" \
-H "Authorization: Bearer $WINGSPAN_TOKEN"Each entry has id, accountId, apiKeyId, sessionId, method, path, queryString, requestHeaders, requestBody, responseStatus, responseBody, latencyMs, ipAddress, userAgent and events.createdAt. The list and the single-entry route return the same fields. Use responseBody to read the problem details and field errors the API sent back.
What is stored
Sensitive values are redacted. A full SSN, bank account number or card number is never stored in plain text. Wingspan keeps the last four digits and a hash so you can match records. Payloads may be missing for older entries, because they are kept for a limited time.
Errors
| Status | Cause |
|---|---|
401, 403 | Missing credentials, or the credential lacks platform.api-request-log:read. |
404 | No log entry with that ID. |
Updated about 1 hour ago