VUZDevelopers

Get client trends

GET
/clients/{clientId}/statistics/trends

Returns trend analysis including:

  • Monthly statistics for the period
  • Total and average revenue
  • Revenue trend (comparing first half to second half)
  • Payment trend (DSO changes)

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

Path Parameters

clientId*string

Client ID

Query Parameters

months?number

Number of months to analyze (default: 12)

Response Body

application/json

curl -X GET "https://example.com/clients/string/statistics/trends"
{  "clientId": "string",  "monthlyStats": [    {      "periodKey": "string",      "year": 0,      "month": 0,      "revenue": 0,      "netRevenue": 0,      "invoiceCount": 0,      "avgInvoiceAmount": 0,      "paymentsReceived": 0,      "paymentCount": 0,      "avgDaysToPayment": 0,      "onTimePaymentRate": 0,      "endingBalance": 0,      "endingOverdue": 0,      "quotesIssued": 0,      "quotesConverted": 0,      "quotedAmount": 0,      "creditNotesIssued": 0,      "creditNotesAmount": 0,      "ratingSnapshot": 0    }  ],  "periodTotalRevenue": 0,  "avgMonthlyRevenue": 0,  "revenueTrend": 0,  "paymentTrend": 0}