VUZDevelopers

Get document summary metrics

GET
/analytics/documents/summary

Retrieves comprehensive document summary metrics for the specified period.

Default Period: Year-to-date (YTD) if no dates provided

Metrics Returned:

  • Total documents created
  • Issued documents count
  • Draft documents count
  • Cancelled documents count
  • Average document value
  • Total value of issued documents

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

startDate?string

Start date (YYYY-MM-DD)

endDate?string

End date (YYYY-MM-DD)

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/documents/summary"
{  "totalDocuments": 0,  "issuedDocuments": 0,  "draftDocuments": 0,  "cancelledDocuments": 0,  "avgDocumentValue": 0,  "totalValue": 0,  "currency": "string",  "startDate": "string",  "endDate": "string"}