Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Retail Sales Reports

Retail Sales Daily Trends

This service provides the retail sales metrics overview for the entire requested period aggregated either by the day of the week or by weekdays/weekend. The insights are available for various of metrics</b>: <ul> <li> <b>sales</b>: The dollar value (USD) of all sales during your selected aggregation.</li> <li> <b>avg_sales</b>: The dollar value (USD) of average sales per day during your selected aggregation.</li> <li> <b>sales_pct</b>: The percentage of total sales which occurred during your selected aggregation.</li> <li> <b>sales_sq_ft</b>: The total value of sales per square foot at the venue examined, during your selected aggregation.</li> <li> <b>transactions</b>: The total number of individual transactions which took place at the property examined during your selected aggregation.</li> <li> <b>transactions_pct</b>:The percentage of total transactions which occurred during your selected .aggregation.</li> <li> <b>avg_ticket_size</b>: The average dollar amount of sales per transaction generated at the venues in your report, per your selected aggregation.</li> </ul> <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/days

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

aggregation'full_week' | 'weekday_weekend'

For the day of week insights you can choose any of the following aggregation options:<br/> <ul> <li> full_week - The aggregation is done per each day of the week</li> <li>weekday_weekend - The aggregation is done for the weekdays altogether and the weekend altogether.</li> </ul>

metricType'sales' | 'avg_sales' | 'sales_pct' | 'sales_sq_ft' | 'transactions' | 'transactions_pct' | 'avg_ticket_size'

The metric for which you wish to get the day of week aggregation for:<br/> <ul> <li> sales: The dollar value (USD) of all sales during your selected aggregation.</li> <li> avg_sales: The dollar value (USD) of average sales per day during your selected aggregation.</li> <li> sales_pct: The percentage of total sales which occurred during your selected aggregation.</li> <li> sales_sq_ft: The total value of sales per square foot at the venue examined, during your selected aggregation.</li> <li> transactions: The total number of individual transactions which took place at the property examined during your selected aggregation.</li> <li> transactions_pct:The percentage of total transactions which occurred during your selected .aggregation.</li> <li> avg_ticket_size: The average dollar amount of sales per transaction generated at the venues in your report, per your selected aggregation.</li> </ul>

Example request

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

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",
    "aggregation": "full_week",
    "metricType": "sales",
    "dayOfWeek": {
      "bins": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday",
        "Sunday"
      ],
      "values": [
        23332019.04,
        20430526.44,
        20256899.97,
        24597150.08,
        30653813.68,
        30801899.86,
        27723322.83
      ]
    }
  }
}