---
title: "Retail Sales Overview"
method: POST
path: "/v1/reports/retail-sales/overview"
tags: ["Retail Sales Reports"]
---

# Retail Sales Overview

`POST /v1/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.

## Request body

- DatesIdParams
  - `startDate` string, date, required — Queried data start date. Format YYYY-MM-DD
  - `endDate` string, date, required — Queried data end date. Format YYYY-MM-DD
  - `apiId` string, required — Placer API Entity Id

## Response `200`

200 response

- SalesOverviewResponse
  - `requestId` string, required — Request ID that can be used for tracing
  - `data` object
    - `startDate` string, date, required — Queried data start date. Format YYYY-MM-DD
    - `endDate` string, date, required — Queried data end date. Format YYYY-MM-DD
    - `apiId` string, required — Placer API Entity Id
    - `salesOverview` object[] — In this array the following overview of various sales metrics calculated for the whole period.
      - `valueType` 'currency' | 'number' — The type of the value provided either 'currency' or 'number'
      - `metricName` string — This will include any of the following values for each array instance:<br/> ● sales: Total sales for the requested period<br/> ● sales_sq_ft: Total sales per SQ FT for the requested period<br/> ● transactions: Total number of transactions done during the requested period<br/> ● avg_daily_unique_customers: Average daily unique visitors amount for the requested period<br/> ● avg_monthly_unique_customers: Average monthly unique visitors amount for the requested period<br/> ● avg_weekly_unique_customers: Average weekly unique visitors amount for the requested period<br/> ● avg_ticket_size: Average ticket size for the requested period
      - `value` number, float — The relevant metric value calculated for the whole period.

## Other responses

- `400` — 400 Bad Request
- `403` — 403 Permission Denied
- `500` — 500 Internal Server Error

---

[API](https://skmtc.net/placer/apis/papi.md) · [All operations](https://skmtc.net/placer/apis/papi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/placer/papi/revisions/e317a0bbbd11/schema)