Skip to main content
GET

​
Workspace Overview Analytics

Use this endpoint for top-level analytics cards in workspace dashboards.

​
Endpoint

  • GET /api/analytics/workspace/overview

​
Query parameters

​
days
number
default:"30"
Date-range window.
​
start
string
Optional explicit start date/time.
​
end
string
Optional explicit end date/time.
​
timezone
string
Optional IANA timezone for date boundaries.
​
currency
string
Optional display currency. Unsupported values are normalized to supported defaults.

​
Response sections

  • summary
    • clicks, visitors, conversions, conversion rate
    • revenue, cost, ROI, average CPA
    • QR scan totals
  • trends
    • period-over-period deltas for clicks/conversions/revenue/cost
  • fraudOverview
    • clean traffic, bot rate, vpn/proxy rate, fraud score (plan-gated)
  • meta
    • campaign/link counts and conversion-tracking flags

​
Request example

​
Notes

  • Monetary fields are returned in requested display currency.
  • Cost metrics derive from campaign cost model/currency settings.
  • When analytics backend is temporarily unavailable, server may return fallback aggregates from workspace/link data.
  • Fraud metrics can be zeroed on plans without fraud features.