API Dashboard

Use Dashboard endpoints to retrieve metrics regarding your API subscription, API limits, logs, and application activity.

Get logs

Retrieve logs for all user's active applications

Parameters
  • per_page optional
    Query parameter. Allowed values: any positive integer starting from 1.
  • page optional
    Query parameter. Allowed values: any positive integer starting from 1.
  • filter:error optional
    Query parameter. Possible values: true/false. Format: ?filters=[{"error":{"type": "=", "value":true}}]
  • filter:applicationId optional
    Query parameter. Possible values: one or several strings in array. Format: ?filters=[{"applicationId":{"type": "in", "value":["e1656509199c931911e919a00b1906ad1a26a450", "e1656509199c931911e919a00b1906ad1a26a451"]}}]
  • filter:method optional
    Query parameter. Possible values: array of strings. Format: ?filters=[{"method":{"type": "in", "value": "POST", "PUT]}}]
  • filter:uri optional
    Query parameter. Possible values: array of strings. Format: ?filters=[{"uri":{"type": "match", "value": "string"}}] - finds only requests where the uri contains the value of the filter; ?filters=[{"uri":{"type": "like", "value": "user"}}] - finds requests where the uri contains text from values of the filter.
  • filter:code optional
    Query parameter. Possible values: array of two integers. Format: ?filters=[{"code":{"type": "between", "value": [0,500]}}]
  • filter:time optional
    Query parameter. Possible values: integer. Format: ?filters=[{"time":{"type": "=", "value": 2}}]
  • filter:created optional
    Query parameter. Possible values: two integers in array. Format: ?filters=[{"created":{"type": "between", "value": [1565360895, 1565360896]}}]
  • sort:created optional
    Query parameter. Sort results in ascending or descending order. Possible values: asc/desc. Format: ?sort[email]=asc
Returns

Returns request logs in case of successful response. Returns an error when:

  • User does not have an active subscription, "code": 0. Message: "User does not have active subscription"
GET /request-logs
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/request-logs \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response
                {
  "data": [
    {
      "user_id": "cd3e07c55a9847a9b36dc7d3bc9ffc0700aa1227",
      "request_id": "5d4d82ffbaf1b",
      "api_version": 2,
      "application_id": "e1656555129c931211e912a00b1206ad1a26a450",
      "error": true,
      "created": 1565360895,
      "request": {
      "host": "gulgowski.org",
      "method": "POST",
      "uri": "adipisci-consequatur-voluptas-illo-dolorem",
      "ip": "93.246.178.226",
      "source": "CLI",
      "body": {
        "data": "Et quia."
      },
      "headers": {
        "User-Agent": "Opera/9.27 (X11; Linux i686; en-US) Presto/2.9.200 Version/10.00"
      }
    },
  "response": {
    "code": 400,
    "time": 1,
    "body": {
      "data": "Optio."
    },
    "headers": null
  }
}
],
"meta": {
  "pagination": {
    "total": 1,
    "count": 1,
    "per_page": 15,
    "current_page": 1,
    "total_pages": 1,
    "links": []
  }
}
}
                
              

Get request log

Retrieve specific user log for an active application

Parameters
  • request_id
    Path parameter. Can be retrieved from GET /request-logs request.
Returns

Returns the request log in case of successful response. Returns an error when:

  • Given {request_id} does not exist or user doesn't own this log, "code": 0. Message: "Request log with ID `{{request_id}}` not found"
  • user does not have an active subscription, "code": 0. Message: "User does not have active subscription"
GET /request-logs/{{request_id}}
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/request-logs/{{request_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response
                {
  "data": {
    "user_id": "172e62b0e3a94735a989c8f5e3a451e7e8d9ba03",
    "request_id": "ebebd9e90c6313e32284cdfdd630eeef",
    "api_version": "legacy",
    "application_id": "15380b86f85e4235b16df86ae59336b1d5b06e32",
    "error": false,
    "created": 1569941241.418,
    "request": {
      "host": "nginx-api-logger.signnow-dev.xyz",
      "method": "POST",
      "uri": "/document",
      "ip": "217.20.164.1",
      "source": "PostmanRuntime/7.17.1",
      "body": {
        "file": {
          "filename": "Test.pdf",
          "mime": "application/pdf",
          "name": "file",
          "size": 147666
        }
      },
      "headers": {
        "authorization": "*****",
        "user-agent": "PostmanRuntime/7.17.1"
      }
    },
    "response": {
      "code": 200,
      "time": "3.126",
      "body": {
        "id": "37c0a7ce2b611b70f9729d8628f373f6ce72b201"
      },
      "headers": {
        "access-control-allow-headers": "Authorization",
        "access-control-allow-origin": "*",
        "connection": "close",
        "content-encoding": "gzip",
        "content-type": "application/json; charset=utf-8",
        "transfer-encoding": "chunked"
      }
    }
  }
}
                
              

Get paid requests

Retrieve statistics about total, used, and remaining API limits.

Returns

Returns total, used, and remaining API limits in case of successful response. Returns an error when:

  • User doesn't have any API subscription plan, "code": 0. Message: "User does not have any API Plan"
GET /v2/paid-request-totals
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/paid-request-totals \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response
                {
    "data": {
        "total": 10,
        "used": 2,
        "remaining": 8,
        "expired": 1605830400,
        "status": "canceled",
        "subscription_id": "5669503709575433796771245877368750673476045434115951839053246345"
    }
}
                
              

Get paid request logs

Retrieve logs of the paid requests.

Parameters
  • page optional
    Query parameter. Allowed values: any positive integer starting from 1.
  • filter:type optional
    Query parameter. Possible values: 'free_form_invite', 'invite_to_sign', 'signing_link', 'document_group_invite', 'bulk_invite'. Format: ?filters=[{"type":{"type":"in","value":["free_form_invite"]}}]
  • filter:date optional
    Query parameter. Possible values: two integers in array or null. Format: ?filters=[{"date":{"type":"between","value":[null,100]}}]
Returns

Returns paid request logs in case of successful response. Returns an error when:

  • User does not have an active subscription, "code": 0. Message: "User does not have active subscription"
GET /v2/paid-request-logs
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/paid-request-logs \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response
                {
  "data": [
    {
      "id": "62fd15c6d7009f3c36fb97279591de91", //unique id of request
      "request_type": "signing_link",
      "uri": "/oauth2/token",
      "method": "POST",
      "date": 1572600281
    },
    {
      "id": "62fd15c6d7009f3c36fb97279591de12", //unique id of request
      "request_type": "free_form_invite",
      "uri": "/oauth2/token",
      "method": "POST",
      "date": 1572600281
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 15,
      "current_page": 1,
      "total_pages": 1,
      "links": []
    }
  }
}
                
              

Export paid request logs

Export logs of the paid requests in an XLSX file.

Parameters
  • filter:date optional
    Query parameter. Possible values: two UNIX timestamps in array or null. Format: ?filters=[{"date":{"type":"between","value":["2019-10-31","2019-10-31"]}}]
  • filter:client_id optional
    Query parameter. Possible values: client_id of the application to get paid request logs for. Format: ?filters=[{"client_id":{"type":"in","value":["{{client_id}}"]}}]
Returns

Returns an XLSX file in case of successful response. Returns an error when:

  • Filter covers more than 90 days, "code": 0. Message: "The `date` filter gap should be 90 days or less."
  • Request with invalid filter, "code": 0. Message: "Wrong filters format."
  • User does not have an active subscription, "code": 0. Message: "User does not have active subscription"
  • Request by the user whose bearer is generated by api dashboard app, "code": 200. empty xlsx file
GET /v2/paid-request-logs/export
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/paid-request-logs/export \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response 200
                
  XLSX file
                
              

Get monthly request totals

Retrieve statistics about total used monthly requests during the subscription period.

Returns

Returns monthly totals in case of successful response. Returns an error when:

  • Request with expired subscription/user does not have subscription, "code": 0. Message: "User does not have active subscription"
GET /v2/paid-request-monthly-totals
cURL
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/paid-request-monthly-totals \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \        
                      
                    
Response
                {
    "data": [
        {
            "201911": {
                "invite_to_sign": 0,
                "bulk_invite": 0,
                "document_group_invite": 0,
                "free_form_invite": 12,
                "signing_link": 0
            }
        },
        {
            "201912": {
                "invite_to_sign": 0,
                "bulk_invite": 0,
                "document_group_invite": 0,
                "free_form_invite": 0,
                "signing_link": 0
            }
        }
    ]
}