VTEX · Schema

TopSearches

Response body object.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
searches	array	List of the 10 most searched terms in the past 14 days.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TopSearches",
  "title": "TopSearches",
  "type": "object",
  "description": "Response body object.",
  "properties": {
    "searches": {
      "type": "array",
      "description": "List of the 10 most searched terms in the past 14 days.",
      "minItems": 10,
      "maxItems": 10,
      "items": {
        "type": "object",
        "description": "Term information.",
        "properties": {
          "term": {
            "type": "string",
            "description": "Search term."
          },
          "count": {
            "type": "number",
            "description": "Number of times the term was searched."
          }
        }
      }
    }
  }
}