Circana · Example Payload

Circana Listretailers Example

AnalyticsConsumer DataMarket ResearchRetailCPGPoint Of SaleConsumer InsightsBusiness Intelligence

Circana Listretailers Example is an example object payload from Circana, 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": "listRetailers",
  "method": "GET",
  "path": "/retailers",
  "summary": "Circana List Retailers",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "ListRetailers200Example",
      "example": {
        "data": [
          {
            "retailer_id": "ret-500123",
            "name": "Example Market",
            "channel": "grocery",
            "store_count": 450,
            "geographic_coverage": "national"
          }
        ],
        "pagination": {
          "offset": 0,
          "limit": 100,
          "total": 1100
        }
      }
    }
  ]
}