Skip to content

Deel: Logs schemas

13 Deel schemas with complete fields and constraints.

← Logs operations · All schemas

List request logs — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe page of results, newest first
data[]ModelEach itemExpand List request logs — 200 response body — data item
pageModelRequired within parentExpand List request logs — 200 response body — page
Keyset pagination envelope for the page just returned

Referenced models: List request logs — 200 response body — data item, List request logs — 200 response body — page

List request logs — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRootOne public API request as recorded by the gateway; payloads and headers are not recorded
api_versionJSONRequired within parent
api_version (anyOf 1)stringAlternativeAPI version the request resolved to
api_version (anyOf 2)nullAlternativeAPI version the request resolved to
duration_msJSONRequired within parent
duration_ms (anyOf 1)integerAlternativeTotal time from request start to response end, in milliseconds
duration_ms (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errorJSONRequired within parentGateway-generated error of a failed request; null when the request succeeded or the error came from the service
error (anyOf 1)ModelAlternativeExpand Retrieve a request log — 200 response body — data error code, message
error (anyOf 2)nullAlternative
ipstringRequired within parentClient IP address the request came from
methodstringRequired within parentHTTP method
pathstringRequired within parentRequest path without the query string
request_idstringRequired within parentThe x-request-id of the request; quote it when contacting support
response_bytesJSONRequired within parent
response_bytes (anyOf 1)JSONAlternative
response_bytes (anyOf 1) (anyOf 1)integerAlternativeSize of the response body in bytes
response_bytes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
response_bytes (anyOf 2)nullAlternativeSize of the response body in bytes
routeJSONRequired within parent
route (anyOf 1)stringAlternativePublic route template the request matched; null when no endpoint matched (404)
route (anyOf 2)nullAlternativePublic route template the request matched; null when no endpoint matched (404)
sourcestringRequired within parentWhere the request came in: REST API, SCIM or an MCP tool call
Known values: rest, scim, mcp
statusJSONRequired within parent
status (anyOf 1)integerAlternativeHTTP status returned to the caller
status (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timestampstringRequired within parentWhen the response was sent (UTC)
Format: date-time
tokenModelRequired within parentExpand Retrieve a request log — 200 response body — data token
The token that made the request, as the gateway saw it at request time
upstream_duration_msJSONRequired within parent
upstream_duration_ms (anyOf 1)JSONAlternative
upstream_duration_ms (anyOf 1) (anyOf 1)integerAlternativeTime spent in the service behind the gateway, in milliseconds; null when the gateway answered itself
upstream_duration_ms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
upstream_duration_ms (anyOf 2)nullAlternativeTime spent in the service behind the gateway, in milliseconds; null when the gateway answered itself
user_agentJSONRequired within parent
user_agent (anyOf 1)stringAlternativeUser-Agent header, truncated to 512 characters
user_agent (anyOf 2)nullAlternativeUser-Agent header, truncated to 512 characters

Referenced models: Retrieve a request log — 200 response body — data error code, message, Retrieve a request log — 200 response body — data token

List request logs — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootKeyset pagination envelope for the page just returned
cursorJSONRequired within parent
cursor (anyOf 1)stringAlternativeCursor for the next page, or null on the last page
cursor (anyOf 2)nullAlternativeCursor for the next page, or null on the last page
has_next_pagebooleanRequired within parentWhether a further page is available

List token activity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe page of results, newest first
data[]ModelEach itemExpand List token activity — 200 response body — data item
pageModelRequired within parentExpand List request logs — 200 response body — page
Keyset pagination envelope for the page just returned

Referenced models: List request logs — 200 response body — page, List token activity — 200 response body — data item

List token activity — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRootOne token's activity over the window
callsJSONRequired within parent
calls (anyOf 1)integerAlternativeRequests made with the token in the window
calls (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dailyarrayRequired within parentPer-day series over the window, oldest first
daily[]ModelEach itemExpand List token activity — 200 response body — data item daily item
errorsJSONRequired within parent
errors (anyOf 1)integerAlternativeRequests that ended in a 4xx or 5xx status
errors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_ipJSONRequired within parent
last_ip (anyOf 1)stringAlternativeClient IP of that latest request
last_ip (anyOf 2)nullAlternativeClient IP of that latest request
last_used_atstringRequired within parentLatest request made with the token (UTC)
Format: date-time
tokenModelRequired within parentExpand List token activity — 200 response body — data item token
The token

Referenced models: List token activity — 200 response body — data item daily item, List token activity — 200 response body — data item token

List token activity — 200 response body — data item daily item

FieldTypePresenceDescription and constraints
$objectRootOne day of the token's activity
callsJSONRequired within parent
calls (anyOf 1)integerAlternativeRequests that day
calls (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
daystringRequired within parentUTC day
Format: date
errorsJSONRequired within parent
errors (anyOf 1)integerAlternativeRequests that day ending in a 4xx or 5xx status
errors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List token activity — 200 response body — data item token

FieldTypePresenceDescription and constraints
$objectRootThe token
idstringRequired within parentToken id shown in the Developer Center
Format: uuid
labelJSONRequired within parent
label (anyOf 1)stringAlternativeToken label or OAuth2 client name at its latest use
label (anyOf 2)nullAlternativeToken label or OAuth2 client name at its latest use
typestringRequired within parentPersonal access token or OAuth2 access token
Known values: pat, oauth2

Retrieve a request log — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve a request log — 200 response body — data
The recorded request together with a human-readable explanation of its outcome

Referenced models: Retrieve a request log — 200 response body — data

Retrieve a request log — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe recorded request together with a human-readable explanation of its outcome
api_versionJSONRequired within parent
api_version (anyOf 1)stringAlternativeAPI version the request resolved to
api_version (anyOf 2)nullAlternativeAPI version the request resolved to
duration_msJSONRequired within parent
duration_ms (anyOf 1)integerAlternativeTotal time from request start to response end, in milliseconds
duration_ms (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errorJSONRequired within parentGateway-generated error of a failed request; null when the request succeeded or the error came from the service
error (anyOf 1)ModelAlternativeExpand Retrieve a request log — 200 response body — data error code, message
error (anyOf 2)nullAlternative
gateway_messagestringRequired within parentWhat the status and gateway error code mean, in plain language
hintstringRequired within parentWhat to do about it
ipstringRequired within parentClient IP address the request came from
methodstringRequired within parentHTTP method
pathstringRequired within parentRequest path without the query string
request_idstringRequired within parentThe x-request-id of the request; quote it when contacting support
response_bytesJSONRequired within parent
response_bytes (anyOf 1)JSONAlternative
response_bytes (anyOf 1) (anyOf 1)integerAlternativeSize of the response body in bytes
response_bytes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
response_bytes (anyOf 2)nullAlternativeSize of the response body in bytes
routeJSONRequired within parent
route (anyOf 1)stringAlternativePublic route template the request matched; null when no endpoint matched (404)
route (anyOf 2)nullAlternativePublic route template the request matched; null when no endpoint matched (404)
sourcestringRequired within parentWhere the request came in: REST API, SCIM or an MCP tool call
Known values: rest, scim, mcp
statusJSONRequired within parent
status (anyOf 1)integerAlternativeHTTP status returned to the caller
status (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timestampstringRequired within parentWhen the response was sent (UTC)
Format: date-time
tokenModelRequired within parentExpand Retrieve a request log — 200 response body — data token
The token that made the request, as the gateway saw it at request time
upstream_duration_msJSONRequired within parent
upstream_duration_ms (anyOf 1)JSONAlternative
upstream_duration_ms (anyOf 1) (anyOf 1)integerAlternativeTime spent in the service behind the gateway, in milliseconds; null when the gateway answered itself
upstream_duration_ms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
upstream_duration_ms (anyOf 2)nullAlternativeTime spent in the service behind the gateway, in milliseconds; null when the gateway answered itself
user_agentJSONRequired within parent
user_agent (anyOf 1)stringAlternativeUser-Agent header, truncated to 512 characters
user_agent (anyOf 2)nullAlternativeUser-Agent header, truncated to 512 characters

Referenced models: Retrieve a request log — 200 response body — data error code, message, Retrieve a request log — 200 response body — data token

Retrieve a request log — 200 response body — data error code, message

FieldTypePresenceDescription and constraints
$objectRootGateway-generated error of a failed request; null when the request succeeded or the error came from the service
codeJSONRequired within parent
code (anyOf 1)stringAlternativeMachine-readable gateway error code
code (anyOf 2)nullAlternativeMachine-readable gateway error code
messageJSONRequired within parent
message (anyOf 1)stringAlternativeHuman-readable gateway error message
message (anyOf 2)nullAlternativeHuman-readable gateway error message

Retrieve a request log — 200 response body — data token

FieldTypePresenceDescription and constraints
$objectRootThe token that made the request, as the gateway saw it at request time
idstringRequired within parentToken id shown in the Developer Center
Format: uuid
labelJSONRequired within parent
label (anyOf 1)stringAlternativeToken label or OAuth2 client name when the request was made
label (anyOf 2)nullAlternativeToken label or OAuth2 client name when the request was made
oauth2_client_idJSONRequired within parent
oauth2_client_id (anyOf 1)stringAlternativeOAuth2 client the token belongs to; null for personal access tokens
Format: uuid
oauth2_client_id (anyOf 2)nullAlternativeOAuth2 client the token belongs to; null for personal access tokens
Format: uuid
typestringRequired within parentPersonal access token or OAuth2 access token
Known values: pat, oauth2

Retrieve request logs summary — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve request logs summary — 200 response body — data
Request counts and latency for the window, computed from hourly rollups

Referenced models: Retrieve request logs summary — 200 response body — data

Retrieve request logs summary — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootRequest counts and latency for the window, computed from hourly rollups
active_tokensJSONRequired within parent
active_tokens (anyOf 1)integerAlternativeDistinct tokens that made at least one request on the days of the window
active_tokens (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
by_status_classobjectRequired within parentRequests per status class, keyed by 2xx, 3xx, 4xx, 5xx
Additional keys: see wildcard field
by_status_class.*JSONAdditional keys
by_status_class.* (anyOf 1)integerAlternative
by_status_class.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fromstringRequired within parentStart of the window the summary covers (UTC)
Format: date-time
p50_msJSONRequired within parent
p50_ms (anyOf 1)integerAlternativeMedian total latency in milliseconds (bucket upper bound)
p50_ms (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
p95_msJSONRequired within parent
p95_ms (anyOf 1)integerAlternative95th percentile total latency in milliseconds (bucket upper bound)
p95_ms (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate_limitedJSONRequired within parent
rate_limited (anyOf 1)integerAlternativeRequests rejected with 429 by the rate limiter
rate_limited (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tostringRequired within parentEnd of the window the summary covers (UTC)
Format: date-time
totalJSONRequired within parent
total (anyOf 1)integerAlternativeRequests in the window
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.