VUZDevelopers

Get document status flow (funnel)

GET
/analytics/documents/status-flow

Retrieves document status flow data for funnel visualization.

Status Flow:

  • Draft → Issued → Paid

Data Returned:

  • Count per status (draft, issued, paid, cancelled)
  • Draft to issued conversion rate
  • Issued to paid conversion rate

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/status-flow"
{  "draft": 0,  "issued": 0,  "paid": 0,  "cancelled": 0,  "draftToIssuedRate": 0,  "issuedToPaidRate": 0,  "currency": "string",  "startDate": "string",  "endDate": "string"}