Skip to content

DocuSign: Gets the Connect failure log information

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

← Esignature operations · Get started

Operation docusign.esignature_connectfailures_getconnectlogs

Provider route: GET /restapi/v2.1/accounts/{accountId}/connect/failures. 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"]["esignatureConnectFailuresGetConnectLogs"]>[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.esignatureConnectFailuresGetConnectLogs(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_connect_failures_get_connect_logs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.from_datestringOptional
query.to_datestringOptional

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 Connect log — response body

Referenced models: Gets the Connect log — response body

Gets the Connect log — response body
FieldTypePresenceDescription and constraints
$objectRoot
failuresarrayOptionalAn array of containing failure information from the Connect failure log.
failures[]ModelEach itemExpand Gets a Connect log entry — response body
logsarrayOptionalA list of Connect general logs.
logs[]ModelEach itemExpand Gets a Connect log entry — response body
totalRecordsstringOptionalThe count of records in the log list.
typestringOptionalThe type of this tab. Values are:

- `Approve`
- `CheckBox`
- `Company`
- `Date`
- `DateSigned`
- `Decline`
- `Email`
- `EmailAddress`
- `EnvelopeId`
- `FirstName`
- `Formula`
- `FullName`
- `InitialHere`
- `InitialHereOptional`
- `LastName`
- `List`
- `Note`
- `Number`
- `Radio`
- `SignerAttachment`
- `SignHere`
- `SignHereOptional`
- `Ssn`
- `Text`
- `Title`
- `Zip5`
- `Zip5Dash4`

Referenced models: Gets a Connect log entry — response body

Gets a Connect log entry — response body
FieldTypePresenceDescription and constraints
$objectRootContains information about a Connect log entry.
accountIdstringOptionalThe account ID associated with the envelope.
configUrlstringOptionalThe web address of the listener or retrieving service endpoint for Connect.
connectDebugLogarrayOptionalA complex element containing information about the Connect configuration, error details, date/time, description and payload.
This information is included in the response only when the `additional_info` query is set to **true.**
This additional information is only available when retrieving general logs with [ConnectEvents:get](/docs/esign-rest-api/reference/connect/connectevents/get/), but not when retrieving failure logs with [ConnectEvents:listFailures](/docs/esign-rest-api/reference/connect/connectevents/listfailures/).
connectDebugLog[]ModelEach itemExpand Gets a Connect log entry — response body — connect Debug Log item
connectIdstringOptionalThe ID of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.
createdstringOptionalThe UTC DateTime when the Connect post was created.
emailstringOptionalThe email address of the envelope sender.
envelopeIdstringOptionalThe ID of the envelope that failed to post.
errorstringOptionalThe error that caused the Connect post to fail.
failureIdstringOptionalThe failure log ID for the failure.
failureUristringOptionalThe URI for the Connect post failure.
lastTrystringOptionalThe UTC DateTime of the last attempt to post.
logIdstringOptionalThe Connect log ID for the entry.
logUristringOptionalThe URI for the Connect log entry.
retryCountstringOptionalThe number of times the Connect post has been retried.
retryUristringOptionalA URI that you can use to retry to publish the Connect post.
statusstringOptionalThe envelope status for the Connect post. Possible values are:
- `Any`
- `Voided`
- `Created`
- `Deleted`
- `Sent`
- `Delivered`
- `Signed`
- `Completed`
- `Declined`
- `TimedOut`
- `Template`
- `Processing`

For details about these statuses, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/).
subjectstringOptionalThe subject of the envelope.
userNamestringOptionalThe name of the sender of the envelope.

Referenced models: Gets a Connect log entry — response body — connect Debug Log item

Gets a Connect log entry — response body — connect Debug Log item
FieldTypePresenceDescription and constraints
$objectRoot
connectConfigstringOptionalThe name of the Connect configuration.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
eventDateTimestringOptionalThe UTC date and time of the event.
eventDescriptionstringOptionalA description of the event.
payloadstringOptionalLog output.

Referenced models: Locks a template — response body — error Details

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

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