addedInput schema / properties / cursor
Added value: +{
+ "description": "next_cursor from the previous page, with the same sort. Omit for the first page.",
+ "type": "string"
+}
addedInput schema / properties / events
Added value: +{
+ "description": "Events to include, such as Purchase. Names are in list_supported_values's `events`. Default: the conversion events. Add PageView to include page views.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 50,
+ "type": "array"
+}
changedInput schema / properties / from / description
Previous value: -"Range start. YYYY-MM-DD is the start of that calendar day in timezone. A full ISO instant is that instant"New value: +"Range start. YYYY-MM-DD means the start of that day in `timezone`; a full ISO 8601 timestamp is used as is."
removedInput schema / properties / group_by
Removed value: -{
- "description": "reason, event_type, or day. Omitted means reason",
- "type": "string"
-}
addedInput schema / properties / limit
Added value: +{
+ "description": "Page size. Default 25.",
+ "maximum": 100,
+ "minimum": 1,
+ "type": "integer"
+}
addedInput schema / properties / reasons
Added value: +{
+ "description": "Reasons to include. Default all.",
+ "items": {
+ "enum": [
+ "denied",
+ "no_decision",
+ "gpc",
+ "bot"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+}
removedInput schema / properties / site
Removed value: -{
- "description": "Domain, id, or external id from list_sites",
- "type": "string"
-}
addedInput schema / properties / site_id
Added value: +{
+ "description": "Site to act on, as returned by list_sites.",
+ "type": "integer"
+}
addedInput schema / properties / sort
Added value: +{
+ "description": "Default newest.",
+ "enum": [
+ "newest",
+ "oldest"
+ ],
+ "type": "string"
+}
changedInput schema / properties / timezone / description
Previous value: -"IANA timezone for day buckets. Omitted means UTC, and the response says UTC"New value: +"IANA time zone such as Europe/Berlin. Default UTC. Returned times and day buckets use it."
changedInput schema / properties / to / description
Previous value: -"Range end. YYYY-MM-DD is the end of that calendar day in timezone, so later events that day are included. A full ISO instant is that instant"New value: +"Range end. YYYY-MM-DD means the end of that day in `timezone`, so the whole day is included; a full ISO 8601 timestamp is used as is."
changedInput schema / required
Previous value: -[
- "site",
- "from",
- "to"
-]New value: +[
+ "site_id",
+ "from",
+ "to"
+]
changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "additionalProperties": false,
+ "properties": {
+ "next_cursor": {
+ "description": "Pass as cursor for the next page. null: last page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "rows": {
+ "description": "One per blocked event, in the requested sort.",
+ "items": {
+ "additionalProperties": false,
+ "description": "One blocked event.",
+ "properties": {
+ "consent_source": {
+ "description": "Consent tool that reported the choice, such as cookieyes or onetrust. null for gpc and bot, and when the site did not report one.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "detail": {
+ "description": "For bot only: the bot pattern detected, such as headless. null otherwise.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "event": {
+ "description": "The event blocked, such as Purchase.",
+ "type": "string"
+ },
+ "hour": {
+ "description": "Start of the hour the event was blocked in, in timezone.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "id": {
+ "description": "Id of this blocked event.",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "denied: the visitor refused consent. no_decision: no consent choice yet where one is required. gpc: the browser sent Global Privacy Control. bot: bot traffic.",
+ "enum": [
+ "denied",
+ "no_decision",
+ "gpc",
+ "bot"
+ ],
+ "type": "string"
+ },
+ "regime": {
+ "description": "Consent rule for the visitor's region. opt_in: consent is needed before tracking. opt_out: tracking is allowed until the visitor refuses.",
+ "enum": [
+ "opt_in",
+ "opt_out"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "hour",
+ "event",
+ "reason",
+ "consent_source",
+ "regime",
+ "detail"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "timezone": {
+ "description": "IANA time zone used for times. UTC when none was passed.",
+ "type": "string"
+ },
+ "window": {
+ "additionalProperties": false,
+ "description": "Exact range read, after applying timezone.",
+ "properties": {
+ "from": {
+ "description": "First instant included.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "to": {
+ "description": "Last instant included.",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from",
+ "to"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "window",
+ "timezone",
+ "next_cursor",
+ "rows"
+ ],
+ "type": "object"
+}