Get Connect failure log information

GET

/v2.1/accounts/:accountId/connect/failures

GET

/restapi/v2.1/accounts/:accountId/connect/failures

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/connect/failures \
     -H "Authorization: Bearer <apiKey>"

{
  "failures": [
    {
      "accountId": "sample string 1",
      "configUrl": "sample string 2",
      "connectDebugLog": [
        {
          "connectConfig": "sample string 1",
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          },
          "eventDateTime": "sample string 2",
          "eventDescription": "sample string 3",
          "payload": "sample string 4"
        }
      ],
      "connectId": "sample string 3",
      "created": "sample string 4",
      "email": "sample string 5",
      "envelopeId": "sample string 6",
      "error": "sample string 7",
      "failureId": "sample string 8",
      "failureUri": "sample string 9",
      "lastTry": "sample string 10",
      "logId": "sample string 11",
      "logUri": "sample string 12",
      "retryCount": "sample string 13",
      "retryUri": "sample string 14",
      "status": "sample string 15",
      "subject": "sample string 16",
      "userName": "sample string 17"
    }
  ],
  "logs": [
    {}
  ],
  "totalRecords": "sample string 1",
  "type": "sample string 2"
}

Retrieves the Connect failure log information.

To use this method, you must be an account administrator and Connect must be enabled on your account.

Use this method to determine which envelopes failed to post. You can then use ConnectEvents: retryForEnvelopes to create a republish request.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

Query parameters

from_datestringOptional

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.

to_datestringOptional

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.

Response

Successful response.

failureslist of objectsOptional

An array of containing failure information from the Connect failure log.

logslist of objectsOptional

A list of Connect general logs.

totalRecordsstringOptional

The count of records in the log list.

typestringOptional

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

Errors

400

Bad Request Error