Search Click

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Click",
  "title": "Search Click",
  "description": "Sends an event every time a shopper clicks on a product from a search page.",
  "type": "object",
  "required": [
    "type",
    "productId",
    "position",
    "text",
    "anonymous",
    "session"
  ],
  "properties": {
    "type": {
      "type": "string",
      "title": "type",
      "description": "Type of event, which can be one of the following: `page.cart`, `page.empty_cart`, `search.query`, `page.confirmation`, `session.ping`, `search.click`.",
      "example": "search.click"
    },
    "productId": {
      "type": "string",
      "description": "Unique identifier of the clicked product.",
      "example": "12345"
    },
    "position": {
      "type": "integer",
      "description": "Position of the clicked product on the search results page.",
      "example": 1
    },
    "url": {
      "type": "string",
      "title": "url",
      "description": "URL that identifies from which page the event occurred.",
      "example": "https://example.com/s?q=pneu&sort=score_desc&page=0"
    },
    "text": {
      "type": "string",
      "title": "text",
      "description": "Query used in the search.",
      "example": "tv"
    },
    "agent": {
      "type": "string",
      "title": "agent",
      "description": "Identifies whether the request came from a mobile or desktop application. It's used as a filter in the search report.",
      "default": "desktop",
      "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:83.0) Gecko/20100101 Firefox/83.0"
    },
    "anonymous": {
      "$ref": "#/components/schemas/UserIdentification/properties/anonymous"
    },
    "session": {
      "$ref": "#/components/schemas/UserIdentification/properties/session"
    }
  }
}