SIsignnow

Export paid request logs

This endpoint allows API users to export logs of the paid requests in an XLSX file.

Notes

  • The date filter can cover up to 90 days.
  • A request with a bearer token generated by the API dashboard app returns an empty XLSX file.
get/v2/paid-request-logs/export

Request

Query parameters

Possible values: an array of two dates in Y-m-d format, up to 90 days apart. Format: ?filters=[{"date":{"type":"between","value":["2019-10-31","2019-10-31"]}}]

Possible values: an array of client IDs of the applications to export paid request logs for. Format: ?filters=[{"clientId":{"type":"in","value":["{{client_id}}"]}}]

Possible values: an array of request types to export paid request logs for: free_form_invite, invite_to_sign, signing_link, document_group_invite, embedded_invite, embedded_group_invite, bulk_invite, document_group_bulk_invite, document_group_free_form_invite. Format: ?filters=[{"type":{"type":"in","value":["signing_link","bulk_invite"]}}]

Response

An XLSX file (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet) named api_usage_report.xlsx, with two sheets:

  • Requests: one row per paid request, with the columns Request Type, Method, URL, Date, Invites Used, Application name, Application id, and Owner.
  • Totals: the number of paid requests per request type.
unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.