changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "description": "ISO 4217 currency for event values.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "domain": {
+ "description": "Website domain.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "external_id": {
+ "description": "Public site id, as in list_sites.",
+ "type": "string"
+ },
+ "is_consent_banner_configured": {
+ "description": "Whether the Get Started item \"configure a consent banner\" is done.",
+ "type": "boolean"
+ },
+ "is_meta_domain_approved": {
+ "description": "Whether the Get Started item \"verify the domain in Facebook Business Manager\" is done.",
+ "type": "boolean"
+ },
+ "is_old_pixel_removed": {
+ "description": "Whether the Get Started item \"remove old pixel code\" is done.",
+ "type": "boolean"
+ },
+ "is_setup_via_ai": {
+ "description": "Whether the site was set up through an AI assistant.",
+ "type": "boolean"
+ },
+ "is_utm_snippet_added": {
+ "description": "Whether the Get Started item \"add UTM parameters to ads\" is done.",
+ "type": "boolean"
+ },
+ "is_webflow_ecommerce": {
+ "description": "Whether the Webflow site uses Webflow eCommerce.",
+ "type": "boolean"
+ },
+ "is_woocommerce": {
+ "description": "Whether the WordPress site uses WooCommerce.",
+ "type": "boolean"
+ },
+ "next_action": {
+ "additionalProperties": false,
+ "description": "The one open setup step. null once setup and every Get Started item that applies to this site are complete.",
+ "properties": {
+ "action": {
+ "description": "Step to do now.",
+ "enum": [
+ "ask_platform",
+ "wordpress_connect",
+ "ask_domain",
+ "ask_currency",
+ "connect_ad_platform",
+ "install",
+ "verify",
+ "triggers",
+ "get_started"
+ ],
+ "type": "string"
+ },
+ "ad_platform": {
+ "description": "Ad platform to connect, for connect_ad_platform. Set only when a saved pixel cannot send yet; absent when the user still has to pick an ad platform.",
+ "type": "string"
+ },
+ "install": {
+ "additionalProperties": false,
+ "description": "For install: the steps and snippet for this site, the same as get_install_instructions returns for task install. When it is set, there is no tool.",
+ "properties": {
+ "docs": {
+ "description": "Help articles for this result: `title` (string) and `url` (string, uri).",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "title": {
+ "type": "string"
+ },
+ "url": {
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "required": [
+ "title",
+ "url"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "native_pixel_search": {
+ "description": "Phase activate only: text to search the site's code for to find an ad platform pixel already on the site. null otherwise.",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "rules_to_follow": {
+ "description": "How to show the snippet to the user; follow them when you present it. null when the result has no snippet.",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "snippet": {
+ "description": "HTML snippet with this site's public site id and key, to paste into the site. null on platforms with a PixelFlow plugin.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "steps": {
+ "description": "Numbered steps for this task on this platform.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "steps",
+ "snippet",
+ "rules_to_follow",
+ "native_pixel_search",
+ "docs"
+ ],
+ "type": "object"
+ },
+ "phase": {
+ "description": "Plugin install phase, for install.",
+ "enum": [
+ "connect",
+ "activate"
+ ],
+ "type": "string"
+ },
+ "progress": {
+ "description": "Position in setup, such as Step 4 of 7. total depends on the site: plugin platforms add a step, and sites that set up conversions add another.",
+ "type": "string"
+ },
+ "say": {
+ "description": "Suggested wording for the user. Words for the user only; the tool for this step is in next_action.tool.",
+ "type": "string"
+ },
+ "step": {
+ "description": "Position in setup, such as Step 4 of 7. total depends on the site: plugin platforms add a step, and sites that set up conversions add another.",
+ "type": "integer"
+ },
+ "steps": {
+ "description": "Every setup step: `step` (integer), `label` (string), `state` (enum: done, current, later).",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "state": {
+ "enum": [
+ "done",
+ "current",
+ "later"
+ ],
+ "type": "string"
+ },
+ "step": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "step",
+ "label",
+ "state"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "target": {
+ "description": "get_connect_link target, for connect_ad_platform.",
+ "enum": [
+ "ad_platform"
+ ],
+ "type": "string"
+ },
+ "task": {
+ "description": "get_install_instructions task, for install.",
+ "enum": [
+ "install"
+ ],
+ "type": "string"
+ },
+ "tool": {
+ "description": "Tool that performs this step. Absent when the step needs no tool or when install is attached.",
+ "type": "string"
+ },
+ "total": {
+ "description": "Position in setup, such as Step 4 of 7. total depends on the site: plugin platforms add a step, and sites that set up conversions add another.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "action",
+ "say",
+ "step",
+ "total",
+ "progress",
+ "steps"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "platform": {
+ "description": "Platform the site runs on, such as webflow.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "site_id": {
+ "description": "Site id.",
+ "type": "integer"
+ },
+ "triggers_added": {
+ "description": "Webflow eCommerce triggers this call added: `trigger_id` (integer), `type` (url), `event` (string, such as Purchase), and `url` (string). Empty when none were added, including when they already exist.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "event": {
+ "type": "string"
+ },
+ "trigger_id": {
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "url"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "trigger_id",
+ "type",
+ "event",
+ "url"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "workspace_id": {
+ "description": "Workspace that owns the site.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "site_id",
+ "external_id",
+ "workspace_id",
+ "domain",
+ "platform",
+ "currency",
+ "is_webflow_ecommerce",
+ "is_woocommerce",
+ "is_setup_via_ai",
+ "is_old_pixel_removed",
+ "is_meta_domain_approved",
+ "is_utm_snippet_added",
+ "is_consent_banner_configured",
+ "triggers_added",
+ "next_action"
+ ],
+ "type": "object"
+}
