VUZDevelopers

Get payment-pages GMV/sales summary

GET
/analytics/payment-pages/summary

Aggregate GMV, sales count, and average sale across all payment pages for a period, reconciled from payment_checkouts (never from the event stream).

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

range?string

Time range for the summary/trend

Default"last30days"

Value in

  • "last7days"
  • "last30days"
  • "last3months"
  • "ytd"
  • "lastyear"
  • "custom"
startDate?string

Start date for custom range (ISO date string)

endDate?string

End date for custom range (ISO date string)

Response Body

application/json

curl -X GET "https://example.com/analytics/payment-pages/summary"
{  "gmv": 0,  "previousGmv": 0,  "salesCount": 0,  "previousSalesCount": 0,  "avgSale": 0,  "docsIssued": 0,  "currency": "ILS",  "periodStart": "string",  "periodEnd": "string"}