Deel: Logs schemas
13 Deel schemas with complete fields and constraints.
← Logs operations · All schemas
List request logs — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The page of results, newest first |
data[] | Model | Each item | Expand List request logs — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One public API request as recorded by the gateway; payloads and headers are not recorded |
api_version | JSON | Required within parent | |
api_version (anyOf 1) | string | Alternative | API version the request resolved to |
api_version (anyOf 2) | null | Alternative | API version the request resolved to |
duration_ms | JSON | Required within parent | |
duration_ms (anyOf 1) | integer | Alternative | Total time from request start to response end, in milliseconds |
duration_ms (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
error | JSON | Required within parent | Gateway-generated error of a failed request; null when the request succeeded or the error came from the service |
error (anyOf 1) | Model | Alternative | Expand Retrieve a request log — 200 response body — data error code, message |
error (anyOf 2) | null | Alternative | |
ip | string | Required within parent | Client IP address the request came from |
method | string | Required within parent | HTTP method |
path | string | Required within parent | Request path without the query string |
request_id | string | Required within parent | The x-request-id of the request; quote it when contacting support |
response_bytes | JSON | Required within parent | |
response_bytes (anyOf 1) | JSON | Alternative | |
response_bytes (anyOf 1) (anyOf 1) | integer | Alternative | Size of the response body in bytes |
response_bytes (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
response_bytes (anyOf 2) | null | Alternative | Size of the response body in bytes |
route | JSON | Required within parent | |
route (anyOf 1) | string | Alternative | Public route template the request matched; null when no endpoint matched (404) |
route (anyOf 2) | null | Alternative | Public route template the request matched; null when no endpoint matched (404) |
source | string | Required within parent | Where the request came in: REST API, SCIM or an MCP tool call Known values: rest, scim, mcp |
status | JSON | Required within parent | |
status (anyOf 1) | integer | Alternative | HTTP status returned to the caller |
status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timestamp | string | Required within parent | When the response was sent (UTC) Format: date-time |
token | Model | Required within parent | Expand 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_ms | JSON | Required within parent | |
upstream_duration_ms (anyOf 1) | JSON | Alternative | |
upstream_duration_ms (anyOf 1) (anyOf 1) | integer | Alternative | Time spent in the service behind the gateway, in milliseconds; null when the gateway answered itself |
upstream_duration_ms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
upstream_duration_ms (anyOf 2) | null | Alternative | Time spent in the service behind the gateway, in milliseconds; null when the gateway answered itself |
user_agent | JSON | Required within parent | |
user_agent (anyOf 1) | string | Alternative | User-Agent header, truncated to 512 characters |
user_agent (anyOf 2) | null | Alternative | User-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Keyset pagination envelope for the page just returned |
cursor | JSON | Required within parent | |
cursor (anyOf 1) | string | Alternative | Cursor for the next page, or null on the last page |
cursor (anyOf 2) | null | Alternative | Cursor for the next page, or null on the last page |
has_next_page | boolean | Required within parent | Whether a further page is available |
List token activity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The page of results, newest first |
data[] | Model | Each item | Expand List token activity — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One token's activity over the window |
calls | JSON | Required within parent | |
calls (anyOf 1) | integer | Alternative | Requests made with the token in the window |
calls (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
daily | array | Required within parent | Per-day series over the window, oldest first |
daily[] | Model | Each item | Expand List token activity — 200 response body — data item daily item |
errors | JSON | Required within parent | |
errors (anyOf 1) | integer | Alternative | Requests that ended in a 4xx or 5xx status |
errors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_ip | JSON | Required within parent | |
last_ip (anyOf 1) | string | Alternative | Client IP of that latest request |
last_ip (anyOf 2) | null | Alternative | Client IP of that latest request |
last_used_at | string | Required within parent | Latest request made with the token (UTC) Format: date-time |
token | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One day of the token's activity |
calls | JSON | Required within parent | |
calls (anyOf 1) | integer | Alternative | Requests that day |
calls (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
day | string | Required within parent | UTC day Format: date |
errors | JSON | Required within parent | |
errors (anyOf 1) | integer | Alternative | Requests that day ending in a 4xx or 5xx status |
errors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List token activity — 200 response body — data item token
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The token |
id | string | Required within parent | Token id shown in the Developer Center Format: uuid |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | Token label or OAuth2 client name at its latest use |
label (anyOf 2) | null | Alternative | Token label or OAuth2 client name at its latest use |
type | string | Required within parent | Personal access token or OAuth2 access token Known values: pat, oauth2 |
Retrieve a request log — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The recorded request together with a human-readable explanation of its outcome |
api_version | JSON | Required within parent | |
api_version (anyOf 1) | string | Alternative | API version the request resolved to |
api_version (anyOf 2) | null | Alternative | API version the request resolved to |
duration_ms | JSON | Required within parent | |
duration_ms (anyOf 1) | integer | Alternative | Total time from request start to response end, in milliseconds |
duration_ms (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
error | JSON | Required within parent | Gateway-generated error of a failed request; null when the request succeeded or the error came from the service |
error (anyOf 1) | Model | Alternative | Expand Retrieve a request log — 200 response body — data error code, message |
error (anyOf 2) | null | Alternative | |
gateway_message | string | Required within parent | What the status and gateway error code mean, in plain language |
hint | string | Required within parent | What to do about it |
ip | string | Required within parent | Client IP address the request came from |
method | string | Required within parent | HTTP method |
path | string | Required within parent | Request path without the query string |
request_id | string | Required within parent | The x-request-id of the request; quote it when contacting support |
response_bytes | JSON | Required within parent | |
response_bytes (anyOf 1) | JSON | Alternative | |
response_bytes (anyOf 1) (anyOf 1) | integer | Alternative | Size of the response body in bytes |
response_bytes (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
response_bytes (anyOf 2) | null | Alternative | Size of the response body in bytes |
route | JSON | Required within parent | |
route (anyOf 1) | string | Alternative | Public route template the request matched; null when no endpoint matched (404) |
route (anyOf 2) | null | Alternative | Public route template the request matched; null when no endpoint matched (404) |
source | string | Required within parent | Where the request came in: REST API, SCIM or an MCP tool call Known values: rest, scim, mcp |
status | JSON | Required within parent | |
status (anyOf 1) | integer | Alternative | HTTP status returned to the caller |
status (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timestamp | string | Required within parent | When the response was sent (UTC) Format: date-time |
token | Model | Required within parent | Expand 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_ms | JSON | Required within parent | |
upstream_duration_ms (anyOf 1) | JSON | Alternative | |
upstream_duration_ms (anyOf 1) (anyOf 1) | integer | Alternative | Time spent in the service behind the gateway, in milliseconds; null when the gateway answered itself |
upstream_duration_ms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
upstream_duration_ms (anyOf 2) | null | Alternative | Time spent in the service behind the gateway, in milliseconds; null when the gateway answered itself |
user_agent | JSON | Required within parent | |
user_agent (anyOf 1) | string | Alternative | User-Agent header, truncated to 512 characters |
user_agent (anyOf 2) | null | Alternative | User-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Gateway-generated error of a failed request; null when the request succeeded or the error came from the service |
code | JSON | Required within parent | |
code (anyOf 1) | string | Alternative | Machine-readable gateway error code |
code (anyOf 2) | null | Alternative | Machine-readable gateway error code |
message | JSON | Required within parent | |
message (anyOf 1) | string | Alternative | Human-readable gateway error message |
message (anyOf 2) | null | Alternative | Human-readable gateway error message |
Retrieve a request log — 200 response body — data token
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The token that made the request, as the gateway saw it at request time |
id | string | Required within parent | Token id shown in the Developer Center Format: uuid |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | Token label or OAuth2 client name when the request was made |
label (anyOf 2) | null | Alternative | Token label or OAuth2 client name when the request was made |
oauth2_client_id | JSON | Required within parent | |
oauth2_client_id (anyOf 1) | string | Alternative | OAuth2 client the token belongs to; null for personal access tokens Format: uuid |
oauth2_client_id (anyOf 2) | null | Alternative | OAuth2 client the token belongs to; null for personal access tokens Format: uuid |
type | string | Required within parent | Personal access token or OAuth2 access token Known values: pat, oauth2 |
Retrieve request logs summary — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request counts and latency for the window, computed from hourly rollups |
active_tokens | JSON | Required within parent | |
active_tokens (anyOf 1) | integer | Alternative | Distinct tokens that made at least one request on the days of the window |
active_tokens (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
by_status_class | object | Required within parent | Requests per status class, keyed by 2xx, 3xx, 4xx, 5xx Additional keys: see wildcard field |
by_status_class.* | JSON | Additional keys | |
by_status_class.* (anyOf 1) | integer | Alternative | |
by_status_class.* (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
from | string | Required within parent | Start of the window the summary covers (UTC) Format: date-time |
p50_ms | JSON | Required within parent | |
p50_ms (anyOf 1) | integer | Alternative | Median total latency in milliseconds (bucket upper bound) |
p50_ms (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
p95_ms | JSON | Required within parent | |
p95_ms (anyOf 1) | integer | Alternative | 95th percentile total latency in milliseconds (bucket upper bound) |
p95_ms (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate_limited | JSON | Required within parent | |
rate_limited (anyOf 1) | integer | Alternative | Requests rejected with 429 by the rate limiter |
rate_limited (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
to | string | Required within parent | End of the window the summary covers (UTC) Format: date-time |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Requests in the window |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |