AiModeMonitorResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/answerline-dev/json-schema/answerline-dev-ai-mode-monitor-response-schema.json",
  "title": "AiModeMonitorResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/answerline-dev-openapi.json#/components/schemas/AiModeMonitorResponse",
  "required": [
    "success",
    "result"
  ],
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "result": {
      "description": "Data returned by AI Mode",
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "description": "Text of the AI Mode answer"
        },
        "html": {
          "type": "string",
          "format": "uri",
          "description": "Present when include.html is true: the link to the stored copy of the AI Mode page."
        },
        "sources": {
          "type": "array",
          "description": "Sources the response cites",
          "items": {
            "type": "object",
            "properties": {
              "position": {
                "type": "number",
                "description": "Where the source sits in the response, as an index"
              },
              "url": {
                "type": "string",
                "description": "Link to the source"
              },
              "label": {
                "type": "string",
                "description": "Label shown for this source"
              },
              "description": {
                "type": "string",
                "description": "Text describing what the source contains"
              },
              "redirectLink": {
                "type": "string",
                "description": "The `/goto` redirect Google used for this link, given in the absolute form that `POST /v1/monitor/google/goto` takes. Only set when Google delivered the link through a redirect; the neighbouring link field contains the destination Answerline reached by following it."
              }
            }
          }
        },
        "citationPills": {
          "type": "array",
          "description": "Citation pills that appear inline in the AI Mode answer. Every element pairs one pill with one source: a pill backed by N sources (Google's `[Label +N]` chips) yields N elements with the same `citationPillId`, each holding that source's own `label`, `url` and `domain`. Grouping by `citationPillId` rebuilds the pills. Not present in `result` if the answer has no pills.",
          "items": {
            "type": "object",
            "required": [
              "label",
              "citationPillId",
              "url",
              "domain",
              "position"
            ],
            "properties": {
              "label": {
                "type": "string",
                "description": "Title of this individual source as shown in the sources rail (e.g. `\"Best Laptops 2026 — Reuters\"`). Empty string if the rail gives no title for it; then identify the source by `domain` / `url`. Entries that share a `citationPillId` each have their own per-source label."
              },
              "citationPillId": {
                "type": "integer",
                "description": "One-based number common to every entry that comes from one chip. Grouping on `citationPillId` rebuilds the chip as displayed; each entry's `label` is specific to its source, so it varies inside a chip."
              },
              "url": {
                "type": "string",
                "description": "Link straight to the cited source."
              },
              "domain": {
                "type": "string",
                "description": "Hostname taken from `url`, useful for grouping and display."
              },
              "description": {
                "type": "string",
                "description": "Source snippet shown in the sources rail, if Google supplies one; omitted when the source has no snippet."
              },
              "position": {
                "type": "integer",
                "description": "Index of this source within the sibling `result.sources` array, starting at 1."
              },
              "redirectLink": {
                "type": "string",
                "description": "The `/goto` redirect Google used for this link, given in the absolute form that `POST /v1/monitor/google/goto` takes. Only set when Google delivered the link through a redirect; the neighbouring link field contains the destination Answerline reached by following it."
              }
            }
          }
        },
        "markdown": {
          "type": "string",
          "description": "The AI Mode answer rendered as Markdown (present when include.markdown is true)"
        },
        "places": {
          "type": "array",
          "description": "Place cards embedded inline in the response",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "description": "Place name"
              },
              "link": {
                "type": "string",
                "format": "uri",
                "description": "URL that opens the place in Google's viewer"
              },
              "placeId": {
                "type": "string",
                "description": "ID of the place in Google Places"
              },
              "index": {
                "type": "integer",
                "description": "Index of the place's position in the results"
              },
              "thumbnail": {
                "type": "string",
                "format": "uri",
                "description": "Thumbnail image URL for the place"
              },
              "rating": {
                "type": "number",
                "description": "Rating in stars (0-5)"
              },
              "reviews": {
                "type": "integer",
                "description": "Review count"
              },
              "type": {
                "type": "string",
                "description": "Category or type of the place"
              },
              "priceLevel": {
                "type": "string",
                "description": "Indicator of the price tier"
              },
              "address": {
                "type": "string",
                "description": "Full address"
              },
              "status": {
                "type": "string",
                "description": "Operating status"
              }
            }
          }
        },
        "shoppingCards": {
          "type": "array",
          "description": "Shopping-related product details parsed from the response",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "description": "Product title"
              },
              "price": {
                "type": "object",
                "description": "Price details in structured form",
                "properties": {
                  "value": {
                    "type": "number",
                    "description": "Numeric price"
                  },
                  "currency": {
                    "type": "string",
                    "description": "Currency symbol"
                  },
                  "raw": {
                    "type": "string",
                    "description": "Price text exactly as the engine showed it (e.g. \"$129.99\")."
                  }
                }
              },
              "store": {
                "type": "string",
                "description": "Merchant/store name"
              },
              "rating": {
                "type": "number",
                "description": "Product rating"
              },
              "reviews": {
                "type": "string",
                "description": "Review count"
              },
              "thumbnail": {
                "type": "string",
                "format": "uri",
                "description": "Product image"
              },
              "productLink": {
                "type": "string",
                "format": "uri",
                "description": "Link straight to the product"
              },
              "oldPrice": {
                "type": "object",
                "description": "Pre-discount price",
                "properties": {
                  "value": {
                    "type": "number",
                    "description": "Numeric price"
                  },
                  "currency": {
                    "type": "string",
                    "description": "Currency symbol"
                  },
                  "raw": {
                    "type": "string",
                    "description": "Price text exactly as the engine showed it (e.g. \"$129.99\")."
                  }
                }
              },
              "snippet": {
                "type": "string",
                "description": "Short product description"
              },
              "snippet_links": {
                "type": "array",
                "description": "Links contained in the product snippet",
                "items": {
                  "type": "object",
                  "properties": {
                    "text": {
                      "type": "string",
                      "description": "Link text"
                    },
                    "link": {
                      "type": "string",
                      "format": "uri",
                      "description": "Link URL"
                    },
                    "redirectLink": {
                      "type": "string",
                      "description": "The `/goto` redirect Google used for this link, given in the absolute form that `POST /v1/monitor/google/goto` takes. Only set when Google delivered the link through a redirect; the neighbouring link field contains the destination Answerline reached by following it."
                    }
                  }
                }
              },
              "position": {
                "type": "integer",
                "description": "Index (0-indexed) of the product card inside the shopping carousel."
              }
            }
          }
        },
        "ads": {
          "type": "object",
          "description": "Section of sponsored ads parsed from the response",
          "properties": {
            "title": {
              "type": "string",
              "description": "Heading of the ads section"
            },
            "ads": {
              "type": "array",
              "description": "List of sponsored ads",
              "items": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string",
                    "description": "Title of the advertised product"
                  },
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "Click-through URL of the ad"
                  },
                  "position": {
                    "type": "integer",
                    "description": "Index of the ad's position"
                  },
                  "price": {
                    "type": "object",
                    "description": "Price details in structured form",
                    "properties": {
                      "value": {
                        "type": "number",
                        "description": "Numeric price"
                      },
                      "currency": {
                        "type": "string",
                        "description": "Currency symbol"
                      }
                    }
                  },
                  "store": {
                    "type": "string",
                    "description": "Merchant/store name"
                  },
                  "rating": {
                    "type": "number",
                    "description": "Product rating"
                  },
                  "reviews": {
                    "type": "string",
                    "description": "Review count"
                  },
                  "redirectLink": {
                    "type": "string",
                    "description": "The `/goto` redirect Google used for this link, given in the absolute form that `POST /v1/monitor/google/goto` takes. Only set when Google delivered the link through a redirect; the neighbouring link field contains the destination Answerline reached by following it."
                  }
                }
              }
            }
          }
        },
        "inlineProducts": {
          "type": "array",
          "description": "Product cards that appear inside the AI answer text",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "description": "Product title"
              },
              "position": {
                "type": "integer",
                "description": "Rank starting at 1 over the `inline_products` array, following the order on the page."
              },
              "price": {
                "type": "object",
                "description": "Price details in structured form",
                "properties": {
                  "value": {
                    "type": "number",
                    "description": "Numeric price"
                  },
                  "currency": {
                    "type": "string",
                    "description": "Currency symbol"
                  }
                }
              },
              "oldPrice": {
                "type": "object",
                "description": "Pre-discount price",
                "properties": {
                  "value": {
                    "type": "number",
                    "description": "Numeric price"
                  },
                  "currency": {
                    "type": "string",
                    "description": "Currency symbol"
                  }
                }
              },
              "store": {
                "type": "string",
                "description": "Merchant/store name"
              },
              "thumbnail": {
                "type": "string",
                "format": "uri",
                "description": "URL of the product image"
              },
              "productLink": {
                "type": "string",
                "format": "uri",
                "description": "Link straight to the product"
              }
            }
          }
        },
        "videos": {
          "type": "array",
          "description": "Video cards shown inline within the AI response (YouTube for now)",
          "items": {
            "type": "object",
            "required": [
              "title",
              "link"
            ],
            "properties": {
              "title": {
                "type": "string",
                "description": "Video title"
              },
              "link": {
                "type": "string",
                "format": "uri",
                "description": "Canonical watch URL with any timestamp parameters removed"
              },
              "platform": {
                "type": "string",
                "description": "Hosting platform read from the byline on the card"
              },
              "channel": {
                "type": "string",
                "description": "Name of the channel or uploader"
              },
              "duration": {
                "type": "string",
                "description": "Duration text as shown (mm:ss or hh:mm:ss)"
              },
              "thumbnail": {
                "type": "string",
                "format": "uri",
                "description": "Publicly accessible thumbnail URL"
              },
              "redirectLink": {
                "type": "string",
                "description": "The `/goto` redirect Google used for this link, given in the absolute form that `POST /v1/monitor/google/goto` takes. Only set when Google delivered the link through a redirect; the neighbouring link field contains the destination Answerline reached by following it."
              }
            }
          }
        },
        "map": {
          "type": "array",
          "description": "Locations pulled from the response, enriched with GPS coordinates",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "description": "Place name"
              },
              "link": {
                "type": "string",
                "format": "uri",
                "description": "URL that opens the place in Google's viewer"
              },
              "placeId": {
                "type": "string",
                "description": "ID of the place in Google Places"
              },
              "index": {
                "type": "integer",
                "description": "Index of the place's position in the results"
              },
              "gps_coordinates": {
                "type": "object",
                "description": "The place's geographic coordinates",
                "properties": {
                  "latitude": {
                    "type": "number",
                    "description": "Latitude coordinate"
                  },
                  "longitude": {
                    "type": "number",
                    "description": "Longitude coordinate"
                  }
                }
              },
              "thumbnail": {
                "type": "string",
                "format": "uri",
                "description": "Thumbnail image URL for the place"
              },
              "rating": {
                "type": "number",
                "description": "Rating in stars (0-5)"
              },
              "reviews": {
                "type": "integer",
                "description": "Review count"
              },
              "type": {
                "type": "string",
                "description": "Category or type of the place"
              },
              "address": {
                "type": "string",
                "description": "Full address"
              },
              "status": {
                "type": "string",
                "description": "Operating status"
              }
            }
          }
        },
        "screenshot": {
          "type": "string",
          "format": "uri",
          "description": "Present when include.screenshot is true and the answer came from a rendered page: the link to the PNG screenshot of the AI Mode page once the answer finished."
        }
      }
    }
  }
}