Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Retail Sales Reports

Retail Sales Trend Report

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.

post/v1/reports/retail-sales/sales-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

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.

Example request

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiId": "venue:7d55054520e387813d764b03",
  "metric": "sales",
  "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",
    "metric": "sales",
    "granularity": "month",
    "annualSales": {
      "bins": [
        "2021",
        "2022",
        "2023",
        "1y"
      ],
      "values": [
        60222003.71,
        58126656.69,
        54654112.81,
        67245632.21
      ]
    },
    "trend": {
      "bins": [
        "2022-08-01",
        "2022-09-01",
        "2022-10-01"
      ],
      "values": [
        60222003.71,
        58126656.69,
        54654112.81
      ]
    }
  }
}