Deel: List request logs
Deel logs.listRequestLogs: arguments, response, policy and SDK examples.
← Logs operations · Get started
Operation deel.logs_listrequestlogs_v2026_10_29
Provider route: GET /logs/requests. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["logs"]["listRequestLogs"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.logs.listRequestLogs(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.logs.list_request_logs(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.search | string | Optional | |
query.request_id | string | Optional | |
query.token_id | string | Optional | Format: uuid |
query.route | string | Optional | |
query.path | string | Optional | |
query.method | string | Optional | |
query.status | integer | Optional | Maximum: 599 Minimum: 100 |
query.status_class | string | Optional | One of: 2xx, 4xx, 5xx |
query.source | string | Optional | One of: rest, scim, mcp |
query.from | string | Optional | Format: date-time |
query.to | string | Optional | Format: date-time |
query.cursor | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List request logs — 200 response body |
Referenced models: List request logs — 200 response body
Schemas
Section titled “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 |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.logs_listrequestlogs_v2026_10_29. Catalog operation: logs_listrequestlogs_v2026_10_29. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["api-logs:read"]
Pinned headers: {"X-Version": "2026-10-29"}