Skip to main content
GET
https://api.taap.it
/
v1
/
stats
/
workspaces
/
summary
Workspace Stats Summary
curl --request GET \
  --url https://api.taap.it/v1/stats/workspaces/summary \
  --header 'Authorization: <authorization>'
{
  "total_clicks": 123,
  "top_countries": [
    {
      "name": "<string>",
      "count": 123
    }
  ],
  "top_devices": [
    {
      "name": "<string>",
      "count": 123
    }
  ],
  "top_browsers": [
    {
      "name": "<string>",
      "count": 123
    }
  ],
  "qr_code_usage": 123,
  "date_range": {
    "start": "<string>",
    "end": "<string>"
  }
}
Request:
cURL
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:
{
  "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

Authorization
string
required
Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Query Parameters

start_date
string
Start date for statistics (YYYY-MM-DD format)
end_date
string
End date for statistics (YYYY-MM-DD format)

Response Fields

total_clicks
integer
required
Total number of clicks across all links in the workspace
top_countries
array
required
Array of top countries by click count across all workspace links
top_devices
array
required
Array of top devices by click count across all workspace links
top_browsers
array
required
Array of top browsers by click count across all workspace links
qr_code_usage
integer
required
Total number of QR code scans across all workspace links
date_range
object
Date range for the statistics