Raw schema
{
"type": "object",
"properties": {
"site_id": {
"type": "string",
"description": "The site's domain as registered in Plausible, e.g. \"example.com\"."
},
"metrics": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"visitors",
"visits",
"pageviews",
"views_per_visit",
"bounce_rate",
"visit_duration",
"events",
"scroll_depth",
"percentage",
"conversion_rate",
"group_conversion_rate",
"average_revenue",
"total_revenue",
"time_on_page"
]
},
"description": "Metrics to compute. Any of: visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, events, scroll_depth, percentage, conversion_rate, group_conversion_rate, average_revenue, total_revenue, time_on_page."
},
"date_range": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Date range: a shortcut string (\"day\", \"7d\", \"28d\", \"30d\", \"91d\", \"month\", \"6mo\", \"12mo\", \"year\", \"all\", \"24h\") OR a 2-element ISO8601 array like [\"2024-01-01\",\"2024-07-01\"] (dates or datetimes with tz)."
},
"dimensions": {
"description": "Group-by dimensions. Event dims (event:goal, event:page, event:hostname), visit dims (visit:source, visit:referrer, visit:utm_medium/source/campaign, visit:device, visit:browser, visit:os, visit:country/region/city[_name], visit:entry_page, visit:exit_page), time dims (time, time:hour, time:day, time:week, time:month), or custom props (event:props:<name>). Omit for totals.",
"type": "array",
"items": {
"type": "string"
}
},
"filters": {
"description": "Optional filters. Each is an array like [\"is\",\"visit:country_name\",[\"Estonia\"]] or [\"contains\",\"event:page\",[\"/blog\"]] with logical wrappers [\"and\",[...]] / [\"or\",[...]] / [\"not\",[...]]. Operators: is, is_not, contains, contains_not, matches, matches_not, has_done, has_not_done.",
"type": "array",
"items": {
"type": "array",
"items": {}
}
},
"order_by": {
"description": "Optional ordering: an array of [metric_or_dimension, \"asc\"|\"desc\"] pairs, e.g. [[\"visitors\",\"desc\"]].",
"type": "array",
"items": {
"type": "array",
"items": {}
}
},
"include": {
"description": "Optional include flags: { imports?, time_labels?, total_rows? }.",
"type": "object",
"properties": {
"imports": {
"description": "Include imported (pre-Plausible) stats.",
"type": "boolean"
},
"time_labels": {
"description": "Include a full list of time labels for the range.",
"type": "boolean"
},
"total_rows": {
"description": "Include the total number of rows in meta.",
"type": "boolean"
}
}
},
"pagination": {
"description": "Optional pagination: { limit?, offset? }.",
"type": "object",
"properties": {
"limit": {
"description": "Rows per page (default 10000).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"offset": {
"description": "Row offset (default 0).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
}
}
},
"required": [
"site_id",
"metrics",
"date_range"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}