Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Loyalty Reports

Visits by Frequency Report

This service enables you to learn about the frequency of visitations to the requested POI.<br/> Insights are provided for all the below types of metrics, bucketed into visitations frequency bins (i.e. 1, 2, 3, …30+ visits per visitor):<br/> <ul> <li><strong>Visitors</strong> - The estimated number of unique visitors to the POI</li> <li><strong>% of Visitors</strong> - The % of unique visitors that visited the POI</li> <li><strong>Visits</strong> - The estimated number of visits to the POI</li> <li><strong>% of Visits</strong> - The % of visits generated by visitors to the POI </li> </ul> <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/loyalty/visits-frequency

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",
  "filter": {
    "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": {
    "startDate": "2020-12-01",
    "endDate": "2021-05-31",
    "apiId": "venue:7d55054520e387813d764b03",
    "avgVisitsPerCustomer": 1.88,
    "medianVisitsPerCustomer": 1,
    "bins": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      15,
      20,
      30
    ],
    "visitors": [
      195397,
      42348,
      20053,
      9578,
      6046,
      3337,
      2013,
      1394,
      1282,
      3195,
      1163,
      385,
      219
    ],
    "visitorsPercentage": [
      68.22,
      14.79,
      7,
      3.34,
      2.11,
      1.17,
      0.7,
      0.49,
      0.45,
      1.12,
      0.41,
      0.13,
      0.08
    ],
    "visits": [
      195397,
      84696,
      60159,
      38311,
      30230,
      20025,
      14089,
      11151,
      11534,
      35719,
      19090,
      8790,
      10029
    ],
    "visitsPercentage": [
      36.24,
      15.71,
      11.16,
      7.1,
      5.61,
      3.71,
      2.61,
      2.07,
      2.14,
      6.62,
      3.54,
      1.63,
      1.86
    ]
  },
  "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"
}