v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB

Retail Sales Reports

Retail Sales Overview

This service provides the retail sales metrics overview for the entire requested period.<br/><br/> <b>Note</b>: Retail sales data currently excludes online transactions and only pertains to sales in brick and mortar locations. Transactions which occurred using the Buy Now Pick Up In Store option may be reflected in the data, depending on the retailer concerned. In the event that Retail Sales data is not available for the report’s entire date range the response will provide the exact dates for which the data applies.

post/v1/reports/retail-sales/overview

Request body

startDatestring date required

Queried data start date. Format YYYY-MM-DD

endDatestring date required

Queried data end date. Format YYYY-MM-DD

apiIdstring required

Placer API Entity Id

Example request

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiId": "venue:7d55054520e387813d764b03"
}

Response

200 response

requestIdstring required

Request ID that can be used for tracing

Example response

{
  "requestId": "cfe57f50-fb64-11eb-8760-acde48001122:cfe56fce-fb64-11eb-8760-acde48001122",
  "data": {
    "startDate": "2020-12-01",
    "endDate": "2021-05-31",
    "apiId": "venue:7d55054520e387813d764b03",
    "salesOverview": [
      {
        "valueType": "currency",
        "metricName": "sales",
        "value": 177795631.94
      },
      {
        "valueType": "currency",
        "metricName": "sales_sq_ft",
        "value": 852.75
      },
      {
        "valueType": "number",
        "metricName": "transactions",
        "value": 3298775.63
      },
      {
        "valueType": "number",
        "metricName": "avg_daily_unique_customers",
        "value": 4611.03
      },
      {
        "valueType": "number",
        "metricName": "avg_monthly_unique_customers",
        "value": 71553.62
      },
      {
        "valueType": "number",
        "metricName": "avg_weekly_unique_customers",
        "value": 27317.12
      },
      {
        "valueType": "currency",
        "metricName": "avg_ticket_size",
        "value": 53.9
      }
    ]
  }
}