Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Visits Reports

Visits by Dwell Time Report

Retrieves visits for a given entity(venue/complex) broken by dwell time periods.<br/> <br/>The response includes:<br/> <ol> <li>Dwell time bins array: [0,5,15,30,45,60,75,90,105,120,135,150] (I.e. 5 represents 5-14 minutes, 150 represents all visits with dwell time higher than or equal to 150)</li> <li>Estimated foot traffic array: Indicates the total visits for the POI during the selected date range for each of the dwell time bins (correlated to the location in the dwell time bins array)</li> <li>Average dwell time</li> <li>Median dwell time</li> </ol> <br/> ⏱ <strong>Average measured processing time: 0.77 seconds </strong><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<br/><br/> 📍 This service supports the <<glossary:Nearby Activity report>>. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic.

post/v1/reports/visit-metrics/dwell-time

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

nearbyRadius100 | 250 | 500 | 750 | 1000

The radius requested for nearby activity report generation.</br> <strong>Note</strong>: When a value is populated for this attribute - the report will be calculated as per the <<glossary:Nearby Activity report>> logic.

Example request

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiId": "venue:7d55054520e387813d764b03",
  "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

visitDurationSegmentation'under10Min' | '10MinOrLonger' | 'allVisits' | 'mixedSegments' nullable

The default visit duration segmentation is returned when the report calculation uses the default segmentation duration.

Example response

{
  "requestId": "cfe57f50-fb64-11eb-8760-acde48001122:cfe56fce-fb64-11eb-8760-acde48001122",
  "data": {
    "bins": [
      0,
      5,
      15,
      30,
      45,
      60,
      75,
      90,
      105,
      120,
      135,
      150
    ],
    "estimatedFoottraffic": [
      0,
      1099,
      290496,
      203518,
      118502,
      62588,
      31487,
      15440,
      6029,
      3405,
      1877,
      3602
    ],
    "average": 41,
    "median": 34
  },
  "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
      }
    }
  },
  "visitDurationSegmentation": "10MinOrLonger"
}