changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "additionalProperties": false,
+ "properties": {
+ "event_count": {
+ "description": "Rows on this page.",
+ "type": "integer"
+ },
+ "events": {
+ "description": "Events, in the requested sort.",
+ "items": {
+ "additionalProperties": false,
+ "description": "One event.",
+ "properties": {
+ "consent": {
+ "additionalProperties": false,
+ "description": "Consent on the event: `state`, `source` (consent tool), `decision_at` (date-time, in timezone) (string or null each), and `regime` (enum: opt_in, opt_out; or null). opt_in: consent is needed before tracking. opt_out: tracking is allowed until the visitor refuses. null when not recorded.",
+ "properties": {
+ "decision_at": {
+ "description": "When the visitor decided.",
+ "format": "date-time",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "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. null when not recorded.",
+ "enum": [
+ "opt_in",
+ "opt_out",
+ null
+ ],
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "source": {
+ "description": "Consent tool.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "state": {
+ "description": "Consent state.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "state",
+ "source",
+ "decision_at",
+ "regime"
+ ],
+ "type": "object"
+ },
+ "currency": {
+ "description": "Event currency.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "error": {
+ "description": "Ad platform error. Set only on a real failure.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "event": {
+ "description": "Event recorded, such as Purchase.",
+ "type": "string"
+ },
+ "event_id": {
+ "description": "Deduplication id shared with the browser pixel.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "first_touch": {
+ "additionalProperties": false,
+ "description": "First and last visit credited: `source`, `utm_campaign`, `utm_term`, `utm_content`, `utm_medium`, `utm_id` (string or null). null when no touch was recorded.",
+ "properties": {
+ "source": {
+ "description": "Source, such as facebook or organic.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_campaign": {
+ "description": "UTM campaign.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_content": {
+ "description": "UTM content (usually the ad).",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_id": {
+ "description": "UTM id.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_medium": {
+ "description": "UTM medium.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_term": {
+ "description": "UTM term (usually the ad set).",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "source",
+ "utm_campaign",
+ "utm_term",
+ "utm_content",
+ "utm_medium",
+ "utm_id"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "id": {
+ "description": "Id of this event row. get_event_payloads takes it in ids. Not the same as event_id.",
+ "type": "integer"
+ },
+ "is_sent_successfully": {
+ "description": "Whether the event was delivered to the ad platforms.",
+ "type": "boolean"
+ },
+ "last_touch": {
+ "additionalProperties": false,
+ "description": "First and last visit credited: `source`, `utm_campaign`, `utm_term`, `utm_content`, `utm_medium`, `utm_id` (string or null). null when no touch was recorded.",
+ "properties": {
+ "source": {
+ "description": "Source, such as facebook or organic.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_campaign": {
+ "description": "UTM campaign.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_content": {
+ "description": "UTM content (usually the ad).",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_id": {
+ "description": "UTM id.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_medium": {
+ "description": "UTM medium.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_term": {
+ "description": "UTM term (usually the ad set).",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "source",
+ "utm_campaign",
+ "utm_term",
+ "utm_content",
+ "utm_medium",
+ "utm_id"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "pixels": {
+ "description": "Per pixel: `pixel_id`, `name`, `ad_platform`, `state` (enum: sent, failed, pending).",
+ "items": {
+ "additionalProperties": false,
+ "description": "One pixel.",
+ "properties": {
+ "ad_platform": {
+ "description": "Ad platform name.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "name": {
+ "description": "Pixel name.",
+ "type": "string"
+ },
+ "pixel_id": {
+ "description": "Pixel id.",
+ "type": "integer"
+ },
+ "state": {
+ "description": "Send status, as in list_events.",
+ "enum": [
+ "sent",
+ "failed",
+ "pending"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "pixel_id",
+ "name",
+ "ad_platform",
+ "state"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "session_id": {
+ "description": "Session id.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "source": {
+ "description": "Traffic source bucket credited.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "time": {
+ "description": "When the event arrived, in timezone.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "url": {
+ "description": "Page URL.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_campaign": {
+ "description": "UTM tag of the visitor in the lookback_days before the event.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_content": {
+ "description": "UTM tag of the visitor in the lookback_days before the event.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_id": {
+ "description": "UTM tag of the visitor in the lookback_days before the event.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_medium": {
+ "description": "UTM tag of the visitor in the lookback_days before the event.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_source": {
+ "description": "UTM tag of the visitor in the lookback_days before the event.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "utm_term": {
+ "description": "UTM tag of the visitor in the lookback_days before the event.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "value": {
+ "description": "Event value.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "visitor_id": {
+ "description": "Visitor id.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "time",
+ "event",
+ "url",
+ "source",
+ "value",
+ "currency",
+ "event_id",
+ "visitor_id",
+ "session_id",
+ "is_sent_successfully",
+ "error",
+ "utm_source",
+ "utm_medium",
+ "utm_campaign",
+ "utm_term",
+ "utm_content",
+ "utm_id",
+ "first_touch",
+ "last_touch",
+ "consent",
+ "pixels"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "lookback_days": {
+ "description": "Days before each event in which the visitor's UTM tags count, for the UTM filters and fields.",
+ "type": "integer"
+ },
+ "next_cursor": {
+ "description": "Pass as cursor for the next page. null: last page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "timezone": {
+ "description": "IANA time zone used for dates and 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",
+ "event_count",
+ "next_cursor",
+ "lookback_days",
+ "events"
+ ],
+ "type": "object"
+}