v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB

Visits Reports

Visit Trends Report for a Single Property

Retrieves visits for a given entity in daily, weekly or monthly granularity.<br/><br/> For more information on request retries best practices and processing measurements you may visit <a href="https://docs.placer.ai/reference/measurements"> this</a> page

post/v1/reports/visit-trends/single

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

granularity'day' | 'week' | 'month' required

Example request

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiId": "venue:7d55054520e387813d764b03",
  "granularity": "month",
  "filters": {
    "audienceType": [
      "visitors"
    ],
    "dwellTime": {
      "operator": "<",
      "value": 150
    },
    "hoursRange": {
      "fromHour": "03:00 am",
      "toHour": "11:59 pm"
    },
    "daysOfWeek": [
      6,
      7
    ],
    "distance": {
      "from": "home",
      "values": {
        "lt": 250,
        "gt": 10
      }
    }
  }
}

Response

200 response

requestIdstring required

Request ID that can be used for tracing

apiIdstring

Placer API Entity Id

Example response

{
  "requestId": "cfe57f50-fb64-11eb-8760-acde48001122:cfe56fce-fb64-11eb-8760-acde48001122",
  "apiId": "venue:7d55054520e387813d764b03",
  "data": {
    "dates": [
      "2020-12-01",
      "2021-01-01",
      "2021-02-01",
      "2021-03-01",
      "2021-04-01",
      "2021-05-01"
    ],
    "granularity": "month",
    "visits": [
      68293,
      67661,
      60130,
      79550,
      79292,
      78276
    ],
    "visitDurationSegmentation": "10MinOrLonger"
  }
}