> ## Documentation Index
> Fetch the complete documentation index at: https://docs.linquid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Workspace Overview Analytics

> Workspace-level KPI summary including conversions, cost model outputs, ROI, and fraud overview

# Workspace Overview Analytics

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

## Endpoint

* `GET /api/analytics/workspace/overview`

## Query parameters

<ParamField query="days" type="number" default="30">
  Date-range window.
</ParamField>

<ParamField query="start" type="string">
  Optional explicit start date/time.
</ParamField>

<ParamField query="end" type="string">
  Optional explicit end date/time.
</ParamField>

<ParamField query="timezone" type="string">
  Optional IANA timezone for date boundaries.
</ParamField>

<ParamField query="currency" type="string">
  Optional display currency. Unsupported values are normalized to supported defaults.
</ParamField>

## 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

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.linquid.io/api/analytics/workspace/overview?days=30&currency=USD" \
    -H "Authorization: Bearer <session_or_api_key>" \
    -H "X-Workspace-Id: ws_123"
  ```
</RequestExample>

## 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.