Skip to content

Deel: Retrieve request logs summary

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

← Logs operations · Get started

Operation deel.logs_retrieverequestlogssummary_v2026_10_29

Provider route: GET /logs/requests/summary. 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"]["retrieveRequestLogsSummary"]>[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.retrieveRequestLogsSummary(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_logs_summary(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.fromstringOptionalFormat: date-time
query.tostringOptionalFormat: date-time
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 request logs summary — 200 response body

Referenced models: Retrieve request logs summary — 200 response body

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]+)?$

SDK function policy ID: deel.logs_retrieverequestlogssummary_v2026_10_29. Catalog operation: logs_retrieverequestlogssummary_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.