Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.

If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.

If the Accept header is set to application/json or application/xml, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.

Request

HTTP request

GET /v2.1/diagnostics/request_logs

Parameters

Parameter NameValueDescription
Optional Query Parameters
encodingstring

Reserved for DocuSign.

Responses

CodeDescriptionReference
200

Successful response.

apiRequestLogsResult
400

Error encountered.

errorDetails

SDK Method

Diagnostics::listRequestLogs

Definitions

apiRequestLog

Contains API request log information.

createdDateTimestring

The UTC DateTime when the item was created.

descriptionstring

A sender-defined description of the line item.

requestLogIdstring

statusstring

The status of the item.

apiRequestLogsResult

Contains information about mutiple API request logs.

apiRequestLogs[apiRequestLog]

Reserved: TBD

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Examples

Generic JSON Response

Response
{}
Generic XML Response

Response
<apiRequestLogsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi" /> 
}} />