Skip to main content

Visitor Breakdown

Top-N visitor breakdown by source, referrer, country, region, device, browser, or OS. Premium only.

GET
/visitors/breakdown
x-api-key<token>

API key used for authentication

In: header

Query Parameters

period?string

Time window. Presets: today, yesterday, last24h, last7d, last30d, last90d, wtd, month. Custom: custom:YYYY-MM-DD:YYYY-MM-DD

Default"last30d"
property*string

Property to break down by. One of visit:source, visit:referrer, visit:country, visit:region, visit:device, visit:browser, visit:os

Value in"visit:source" | "visit:referrer" | "visit:country" | "visit:region" | "visit:device" | "visit:browser" | "visit:os"

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/visitors/breakdown?property=visit%3Asource"
{
  "items": [
    {
      "source": "Direct / None",
      "visitors": 450,
      "pageviews": 1200
    },
    {
      "source": "Twitter",
      "visitors": 210,
      "pageviews": 580
    },
    {
      "source": "Twitch",
      "visitors": 90,
      "pageviews": 240
    }
  ]
}
{
  "error": "string",
  "code": "string",
  "details": {}
}