---
title: "Retail Sales Trend Report"
method: POST
path: "/v1/reports/retail-sales/sales-trends"
tags: ["Retail Sales Reports"]
---

# Retail Sales Trend Report

`POST /v1/reports/retail-sales/sales-trends`

This service provides the insights about sales performance at each venue examined in the report. Within the response of this service you will be receiving both the requested insights based on the date range, granularity and type of metric, and the annual sales for the past year-to-date and 3 last calendar years.<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

- SalesTrendRequest
  - `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
  - `metric` 'sales' | 'sales_sq_ft' — The metric requested for the report. Can be one of the following:</br> <strong>sales </strong>- The total dollar value (USD) of all sales generated for the requested venue.</br> <strong>sales_sq_ft</strong> - The total dollar value (USD) of sales per SQ FT generated for the requested venue.
  - `granularity` 'day' | 'week' | 'month' — The aggregation of data requested for the report. Can be one of month, week or day.

## Response `200`

200 response

- SalesTrendResponse
  - `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
    - `metric` 'sales' | 'sales_sq_ft' — The metric requested for the report. Can be one of the following:</br> <strong>sales </strong>- The total dollar value (USD) of all sales generated for the requested venue.</br> <strong>sales_sq_ft</strong> - The total dollar value (USD) of sales per SQ FT generated for the requested venue.
    - `granularity` 'day' | 'week' | 'month' — The aggregation of data requested for the report. Can be one of month, week or day.
    - `annualSales` object — Presents the annual sales in bins per year including last 3 years and last 12 months.
      - `bins` string[] — Array of bins specifying the years which the sales info in the values array refer to
      - `values` number[] — Correlated sales info values to the bins array
    - `trend` object — Presents the sales divided into bins based on the requested granularity.
      - `bins` string[] — Presents the sales in bins based on the requested granularity (e.g. in <b>month</b> granularity each bin will present the first date of the month, for <b>day</b> granularity each bin will present each day of the report date range)
      - `values` number[] — Correlated sales info values to the bins array

## 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)