VUZDevelopers

Get collection trend over time

GET
/analytics/collections/trend

Retrieves time-series data for collections trend visualization.

Granularity Options:

  • daily: Individual day data points
  • weekly: Weekly aggregated data
  • monthly: Monthly aggregated data (default)

Data Returned:

  • Billed amount per period
  • Collected amount per period
  • Collection rate per period

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)

granularity?string

Data granularity

Default"monthly"

Value in

  • "daily"
  • "weekly"
  • "monthly"

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/collections/trend"
{  "granularity": "string",  "currency": "string",  "startDate": "string",  "endDate": "string",  "dataPoints": [    {      "date": "string",      "label": "string",      "labelEn": "string",      "billed": 0,      "collected": 0,      "collectionRate": 0    }  ]}