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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.from_date | string | Optional | |
query.to_date | string | Optional |
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 Gets the Connect log — response body |
Referenced models: Gets the Connect log — response body
Schemas
Section titled “Schemas”Gets the Connect log — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failures | array | Optional | An array of containing failure information from the Connect failure log. |
failures[] | Model | Each item | Expand Gets a Connect log entry — response body |
logs | array | Optional | A list of Connect general logs. |
logs[] | Model | Each item | Expand Gets a Connect log entry — response body |
totalRecords | string | Optional | The count of records in the log list. |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about a Connect log entry. |
accountId | string | Optional | The account ID associated with the envelope. |
configUrl | string | Optional | The web address of the listener or retrieving service endpoint for Connect. |
connectDebugLog | array | Optional | A 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[] | Model | Each item | Expand Gets a Connect log entry — response body — connect Debug Log item |
connectId | string | Optional | The 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. |
created | string | Optional | The UTC DateTime when the Connect post was created. |
email | string | Optional | The email address of the envelope sender. |
envelopeId | string | Optional | The ID of the envelope that failed to post. |
error | string | Optional | The error that caused the Connect post to fail. |
failureId | string | Optional | The failure log ID for the failure. |
failureUri | string | Optional | The URI for the Connect post failure. |
lastTry | string | Optional | The UTC DateTime of the last attempt to post. |
logId | string | Optional | The Connect log ID for the entry. |
logUri | string | Optional | The URI for the Connect log entry. |
retryCount | string | Optional | The number of times the Connect post has been retried. |
retryUri | string | Optional | A URI that you can use to retry to publish the Connect post. |
status | string | Optional | The 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/). |
subject | string | Optional | The subject of the envelope. |
userName | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
connectConfig | string | Optional | The name of the Connect configuration. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
eventDateTime | string | Optional | The UTC date and time of the event. |
eventDescription | string | Optional | A description of the event. |
payload | string | Optional | Log output. |
Referenced models: Locks a template — response body — error Details
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.