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.
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"]["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 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.retrieve_request_logs_summary(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.from | string | Optional | Format: date-time |
query.to | string | Optional | Format: date-time |
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 Retrieve request logs summary — 200 response body |
Referenced models: Retrieve request logs summary — 200 response body
Schemas
Section titled “Schemas”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]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}