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/diagnostics/request_logs

Parameters

Parameter name Value Description
Optional query parameters
encoding string

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Diagnostics::listRequestLogs

Definitions Expand All | Collapse All

apiRequestLog

Contains API request log information.

createdDateTime string

Indicates the date and time the item was created.

description string

A sender-defined description of the line item.

requestLogId string
status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.

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.

errorCode string

An error code associated with the error.

message string

A short error message.

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" />