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

# Workspace Stats Summary

> Get aggregated statistics for your workspace

**Request:**

```bash cURL theme={null}
curl -X GET 'https://api.taap.it/v1/stats/workspaces/summary?start_date=2024-01-01&end_date=2024-01-31' \
  -H 'Authorization: Bearer taapit_your_api_key_here'
```

**Response:**

```json theme={null}
{
  "total_clicks": 15750,
  "top_countries": [
    {"name": "US", "count": 8250},
    {"name": "CA", "count": 3150},
    {"name": "UK", "count": 2250}
  ],
  "top_devices": [
    {"name": "mobile", "count": 9450},
    {"name": "desktop", "count": 5250},
    {"name": "tablet", "count": 1050}
  ],
  "top_browsers": [
    {"name": "Chrome", "count": 10000},
    {"name": "Safari", "count": 3750},
    {"name": "Firefox", "count": 1500}
  ],
  "qr_code_usage": 525,
  "date_range": {
    "start": "2024-01-01",
    "end": "2024-01-31"
  }
}
```

## Authorization

<ParamField header="Authorization" type="string" required>
  Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
</ParamField>

## Query Parameters

<ParamField query="start_date" type="string">
  Start date for statistics (YYYY-MM-DD format)
</ParamField>

<ParamField query="end_date" type="string">
  End date for statistics (YYYY-MM-DD format)
</ParamField>

## Response Fields

<ResponseField name="total_clicks" type="integer" required>
  Total number of clicks across all links in the workspace
</ResponseField>

<ResponseField name="top_countries" type="array" required>
  Array of top countries by click count across all workspace links

  <Expandable title="Country object properties">
    <ResponseField name="name" type="string" required>
      Country code (ISO 3166-1 alpha-2)
    </ResponseField>

    <ResponseField name="count" type="integer" required>
      Number of clicks from this country
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="top_devices" type="array" required>
  Array of top devices by click count across all workspace links

  <Expandable title="Device object properties">
    <ResponseField name="name" type="string" required>
      Device type (mobile, desktop, tablet)
    </ResponseField>

    <ResponseField name="count" type="integer" required>
      Number of clicks from this device type
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="top_browsers" type="array" required>
  Array of top browsers by click count across all workspace links

  <Expandable title="Browser object properties">
    <ResponseField name="name" type="string" required>
      Browser name (Chrome, Safari, Firefox, etc.)
    </ResponseField>

    <ResponseField name="count" type="integer" required>
      Number of clicks from this browser
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="qr_code_usage" type="integer" required>
  Total number of QR code scans across all workspace links
</ResponseField>

<ResponseField name="date_range" type="object">
  Date range for the statistics

  <Expandable title="Date range properties">
    <ResponseField name="start" type="string" required>
      Start date of the statistics period
    </ResponseField>

    <ResponseField name="end" type="string" required>
      End date of the statistics period
    </ResponseField>
  </Expandable>
</ResponseField>
