Envelope Statistics (GET /v2.0/account/statistics)
This method lists account envelope statistics.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned message |
Response Body Data Fields
| Field | Always Present? | Description |
|---|---|---|
| envelope_stats | Yes | Envelope statistics JSON object |
| completed | Yes | Count of completed documents in account |
| declined | Yes | Count of declined documents in account |
| expired | Yes | Count of expired documents in account |
| failed | Yes | Count of failed documents in account |
| cancelled | Yes | Count of cancelled documents in account |
Sample Success Response
REQUEST:
curl --location --request GET 'api/v2.0/account/statistics' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9'
RESPONSE:
{
"message": "",
"data": {
"document_stats": {
"completed": 50,
"declined": 2,
"expired": 30,
"failed": 0,
"cancelled": 2
}
}
}
Sample Error Response
REQUEST:
curl --location --request GET 'api/v2.0/account/statistics' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9'
RESPONSE:
{
"errors": [
{
"error_code": "SYSTEM_ERROR", "
developer_message": "The server encountered an unhandled error."
}
]
}
Note: View the full list of applicable error code for this method here.