Raw schema
{
"type": "object",
"properties": {
"domain_id": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Pirsch domain (dashboard) id. Get it from pirsch_list_domains."
},
"from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "First day, yyyy-mm-dd (in the dashboard time zone unless tz is set)."
},
"to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Last day, yyyy-mm-dd, whole day included."
},
"tz": {
"description": "IANA time zone such as Europe/Berlin. Default: the dashboard's time zone.",
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9_+\\-/]+$"
},
"type": {
"description": "all (default), entry or exit pages.",
"type": "string",
"enum": [
"all",
"entry",
"exit"
]
},
"include_title": {
"description": "Group by title and path instead of path only.",
"type": "boolean"
},
"hostname": {
"description": "Hostname (useful for rollup views). Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"path": {
"description": "Page path, for example /pricing. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"entry_path": {
"description": "Entry page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"exit_path": {
"description": "Exit page path. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"pattern": {
"description": "Regular expression that filters and groups pages, for example (?i)^/blog/[^/]+$.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"event": {
"description": "Event name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"language": {
"description": "ISO 639-1 language code such as en. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"country": {
"description": "ISO 3166 alpha-2 country code such as jp. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"city": {
"description": "City name. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"referrer": {
"description": "Referrer, usually a URL. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"referrer_name": {
"description": "Referrer name, usually the hostname. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"channel": {
"description": "Traffic channel such as \"Paid Search\" or \"Organic Search\". Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"os": {
"description": "Operating system. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"browser": {
"description": "Browser. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"platform": {
"description": "Platform.",
"type": "string",
"enum": [
"desktop",
"mobile",
"unknown"
]
},
"screen_class": {
"description": "Screen class XXL, XL, L, M or S. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_source": {
"description": "UTM source. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_medium": {
"description": "UTM medium. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_campaign": {
"description": "UTM campaign. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_content": {
"description": "UTM content. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"utm_term": {
"description": "UTM term. Optional filter. A value may start with ! (is not), ~ (contains) or ^ (does not contain).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"tag": {
"description": "Tag key to filter for.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"event_meta": {
"description": "Event metadata key/value pairs; only events with all pairs match.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"tags": {
"description": "Tag key/value pairs; only results with all pairs match.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"description": "Results to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"sort": {
"description": "Field to sort by, for example visitors, views, sessions or bounce_rate.",
"type": "string",
"pattern": "^[a-z_]{1,40}$"
},
"direction": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"search": {
"description": "Only rows whose main field contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"domain_id",
"from",
"to"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}