Raw schema
{
"type": "object",
"properties": {
"hostname": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"description": "Website hostname as shown in Simple Analytics, e.g. example.com (from simpleanalytics_list_websites)."
},
"dimension": {
"type": "string",
"enum": [
"pages",
"countries",
"referrers",
"utm_sources",
"utm_mediums",
"utm_campaigns",
"utm_contents",
"utm_terms",
"browser_names",
"os_names",
"device_types"
],
"description": "What to break the traffic down by."
},
"start": {
"description": "Start date: YYYY-MM-DD, today, yesterday or today-30d. Default: 1 month ago.",
"type": "string"
},
"end": {
"description": "End date (inclusive): YYYY-MM-DD, today, yesterday or today-1d. Default: today.",
"type": "string"
},
"limit": {
"description": "Maximum number of values (default 20, max 1000).",
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"timezone": {
"description": "IANA time zone, e.g. Europe/Amsterdam. Default: the website setting.",
"type": "string"
},
"page": {
"description": "Only this page path, e.g. /pricing. A trailing * matches a prefix (/blog/*).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"pages": {
"description": "Only these page paths, comma separated (/contact,/product/*).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"country": {
"description": "Only this country, 2-letter code (NL).",
"type": "string",
"pattern": "^[A-Za-z]{2}$"
},
"referrer": {
"description": "Only this referrer (normalized, e.g. google.com).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_source": {
"description": "Only this UTM source.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_medium": {
"description": "Only this UTM medium.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_campaign": {
"description": "Only this UTM campaign.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_content": {
"description": "Only this UTM content.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_term": {
"description": "Only this UTM term.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"browser_name": {
"description": "Only this browser name (Chrome).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"os_name": {
"description": "Only this OS name (iOS).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"device_type": {
"description": "Only this device type.",
"type": "string",
"enum": [
"mobile",
"tablet",
"desktop",
"tv"
]
},
"metadata": {
"description": "Exact metadata filters as {key: value}; all must match.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[a-zA-Z0-9_]+$"
},
"additionalProperties": {
"type": "string",
"maxLength": 200
}
}
},
"required": [
"hostname",
"dimension"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}