Skip to content

DocuSign: Gets the API request logging log files

DocuSign esignature.esignatureApirequestLogGetRequestLogs: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_apirequestlog_getrequestlogs

Provider route: GET /restapi/v2.1/diagnostics/request_logs. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureApirequestLogGetRequestLogs"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureApirequestLogGetRequestLogs(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_apirequest_log_get_request_logs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.encodingstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets the API request logging log files — response body

Referenced models: Gets the API request logging log files — response body

Gets the API request logging log files — response body
FieldTypePresenceDescription and constraints
$objectRootContains information about multiple API request logs.
apiRequestLogsarrayOptionalReserved for Docusign.
apiRequestLogs[]ModelEach itemExpand Gets the API request logging log files — response body — api Request Logs item

Referenced models: Gets the API request logging log files — response body — api Request Logs item

Gets the API request logging log files — response body — api Request Logs item
FieldTypePresenceDescription and constraints
$objectRootContains API request log information.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
descriptionstringOptionalThe API endpoint that was called.
requestLogIdstringOptionalThe ID of the log entry.
statusstringOptionalThe status of the API request.

SDK function policy ID: docusign.esignature_apirequestlog_getrequestlogs. Catalog operation: esignature:APIRequestLog_GetRequestLogs. 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.

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.