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

# Retail Sales Transactions Trends Report

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

The Transaction Trend presents the total number of transactions generated at the venues in your report over time. You can compare the venue's transaction trend against its category or chain average.<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

- TransactionTrendRequest
  - `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
  - `compareType` 'avg_chain_in_state' | 'avg_chain_nationwide' | 'avg_category_in_state' | 'avg_category_nationwide', nullable — The chain or category trend to compare with<br/> <ul> <li>None</il> <li>avg_chain_in_state</li> <li>avg_chain_nationwide</li> <li>avg_category_in_state</li> <li>avg_category_nationwide</li> </ul>
  - `granularity` 'day' | 'week' | 'month' — The aggregation of data requested for the report. Can be one of month, week or day.

## Response `200`

200 response

- TransactionTrendResponse
  - `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
    - `compareType` 'avg_chain_in_state' | 'avg_chain_nationwide' | 'avg_category_in_state' | 'avg_category_nationwide', nullable — Will be presented if requested.
    - `granularity` 'day' | 'week' | 'month' — The aggregation of data requested for the report. Can be one of month, week or day.
    - `trend` object
      - `bins` string[] — Presents the transactions trends for the requested POI during the requested period based on the selected granularity.
      - `values` number[] — Presents the sales transactions 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)
    - `compare` object, nullable
      - `bins` string[] — Presents the sales transactions 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)