VUZDevelopers

Get revenue breakdown by brand (שם מסחרי)

GET
/analytics/revenue/by-brand

Retrieves revenue breakdown by brand for the specified period.

Grouping: by document.brandId. Documents issued before brands existed (or under a business with no brands configured) roll up into a single "no brand" bucket (brandId: null) instead of being dropped.

Historical revenue is never hidden: a brand that has since been deactivated still shows its revenue for the period — each item carries the brand's current isActive flag so the UI can de-emphasize it, not drop it.

Data Returned:

  • Revenue and document count per brand (and the "no brand" bucket, if applicable)
  • Percentage of total revenue per brand
  • Whether each brand is currently active

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 for analytics range (ISO date string)

endDate?string

End date for analytics range (ISO date string)

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/revenue/by-brand"
{  "currency": "ILS",  "startDate": "2025-01-01",  "endDate": "2025-12-31",  "brands": [    {      "brandId": "b1a2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",      "brandName": "אקו דב",      "brandNameEn": "Echo Dev",      "isActive": true,      "revenue": 125000.5,      "percentage": 27.8,      "documentCount": 24    }  ],  "totalBrands": 2,  "totalRevenue": 450000.5}