VTEX · Example Payload

Vtex Get Top Searches Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Top Searches Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "get-top-searches",
  "method": "GET",
  "path": "/top_searches",
  "summary": "VTex Get list of the 10 most searched terms",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "searches": [
          {
            "term": "home",
            "count": 14
          },
          {
            "term": "shirt",
            "count": 10
          },
          {
            "term": "top",
            "count": 9
          },
          {
            "term": "tops",
            "count": 6
          },
          {
            "term": "camera",
            "count": 5
          },
          {
            "term": "kit",
            "count": 5
          },
          {
            "term": "work shirt",
            "count": 2
          },
          {
            "term": "shirts",
            "count": 2
          },
          {
            "term": "clothing",
            "count": 2
          },
          {
            "term": "classic shoes",
            "count": 1
          }
        ]
      }
    }
  ]
}