Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Visits Reports

Visit Trends Report

Retrieves visitations for a given list of entities in daily, weekly or monthly granularity.<br/><br/> <strong>⇡ This service supports bulk request</strong><br/><br/> <strong> ✽ This service supports chain level requests</strong><br/><br/> ⏱ <strong>Average measured processing time: 3.58 seconds </strong><br><br> <strong>📍 This service doesn't support custom POI. To pull visits trend for custom POI please use <a href="https://docs.placer.ai/reference/post_v1-reports-visit-trends-single">Visit Trends Report for a Single Property </a> endpoint. </strong><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

Request body

startDatestring date required

Queried data start date. Format YYYY-MM-DD

endDatestring date required

Queried data end date. Format YYYY-MM-DD

apiIdsApiId[] required
granularity'day' | 'week' | 'month' required
visitDurationSegmentation'under10Min' | '10MinOrLonger' | 'allVisits' | 'default' nullable

This parameter allows for the generation of reports based on either short visits (< 10 minutes), long visits (>= 10 minutes), or all visit data. <br/> By setting the parameter with a “default” value the report may be limited to certain visit durations (length of stay in minutes), to best reflect the typical behavior of visitors.<br> <strong>Available values:</strong><br> ‘under10Min’ - Only visits with a duration of less than 10 minutes are included in the report.<br> ‘10MinOrLonger’ - only visits with a duration of 10 minutes or more are included in the report.<br> ‘allVisits’ - all the visits are included in the report.<br> ‘default’ - The default segment (as explained above)

Example request

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiIds": [
    "venue:7d55054520e387813d764b03"
  ],
  "granularity": "month",
  "filters": {
    "daysOfWeek": [
      6,
      7
    ],
    "distance": {
      "from": "home",
      "values": {
        "lt": 250,
        "gt": 10
      }
    }
  },
  "visitDurationSegmentation": "10MinOrLonger"
}

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",
  "items": [
    {
      "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
        ],
        "panelVisits": [
          1856,
          1962,
          1745,
          2145,
          1996,
          1842
        ],
        "visitDurationSegmentation": "10MinOrLonger"
      }
    }
  ]
}