Skip to content

Deel: Retrieve a request log

Deel logs.retrieveRequestLog: arguments, response, policy and SDK examples.

← Logs operations · Get started

Operation deel.logs_retrieverequestlog_v2026_10_29

Provider route: GET /logs/requests/{request_id}. Alter supplies the connection’s credentials and routing.

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"]["retrieveRequestLog"]>[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.retrieveRequestLog(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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.retrieve_request_log(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.request_idstringRequired within parent
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a request log — 200 response body

Referenced models: Retrieve a request log — 200 response body

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

SDK function policy ID: deel.logs_retrieverequestlog_v2026_10_29. Catalog operation: logs_retrieverequestlog_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"}

Official provider source

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.