Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Retail Sales Reports

Retail Sales Transactions Trends Report

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.

post/v1/reports/retail-sales/transaction-trends

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

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.

Example request

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

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",
    "compareType": "avg_chain_in_state",
    "granularity": "month",
    "trend": {
      "bins": [
        "2022-08-01",
        "2022-09-01",
        "2022-10-01"
      ],
      "values": [
        138915.39,
        139320.64,
        136581.83
      ]
    },
    "compare": {
      "bins": [
        "2022-08-01",
        "2022-09-01",
        "2022-10-01"
      ],
      "values": [
        138915.39,
        139320.64,
        136581.83
      ]
    }
  }
}