Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Visits Reports

Visit Metrics Summary Report

Retrieves visitors and visits for a given list of entities. <br/>This endpoint supports bulk requests up to 100 entities<br/><br/><strong>⇡ This service supports bulk request</strong><br/> When nearbyRadius is set, a report will be generated for the first entity in the array <strong>only</strong>.<br/> <br/> ⏱ <strong>Average measured processing time: 10 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<br/><br/>

post/v1/reports/visit-metrics

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
includeMetadataboolean

If the parameter is set to true, the response will also include the POI Info

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",
  "apiIds": [
    "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

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": {
        "panelVisitors": 5655,
        "panelVisits": 11546,
        "visits": 433202,
        "visitors": 184092,
        "visitDurationSegmentation": "10MinOrLonger",
        "metadata": {
          "apiId": "venue:7d55054520e387813d764b03",
          "name": "Walmart",
          "entityId": "7d55054520e387813d764b03",
          "entityType": "venue",
          "categoryInfo": {
            "category": "Fast Food & QSR",
            "group": "Dining",
            "subCategory": "Pizze Place"
          }
        }
      }
    }
  ]
}