v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB

Visits Reports

Visit by CBGs Report

This service populates a report of the CBGs that generate visitation to the properties examined. You may assess visitations per each CBG. You may also determine the desired data granularity.<br/><br/> <strong>⇡ This service supports bulk request</strong><br/><br/> <strong>📍 This service doesn't support custom POI. </strong><br/><br/> * <strong>Please note</strong> that sparsely populated CBGs may not be included in the feed to align with Placer's privacy policy.<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-metrics/cbgs

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

location'Home'

This parameter determines which CBGs will be listed in the response of the visiting CBGs - The ones that are considered as the visitors' home or the ones considered as their work.</br>*Currently available for home CBGs only

granularity'week' | 'month' | 'year' required

The data aggregation granularity requested

trafficVolPct70 | 100

The threshold for the volume of traffic coming to the property.<br> For example - setting a traffic volume percentage of 70 will draw a polygon that includes at least 70% of the visitors’ home location, where 100 will consider all CBGs visited from to the requested POI

Example request

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiIds": [
    "venue:7d55054520e387813d764b03"
  ],
  "location": "Home",
  "granularity": "month",
  "trafficVolPct": 70
}

Response

200 response

startDatestring date required

Queried data start date. Format YYYY-MM-DD

endDatestring date required

Queried data end date. Format YYYY-MM-DD

apiIdsApiId[] required

location'Home'

This parameter determines which CBGs will be listed in the response of the visiting CBGs - The ones that are considered as the visitors' home or the ones considered as their work.</br>*Currently available for home CBGs only

granularity'week' | 'month' | 'year' required

The data aggregation granularity requested

trafficVolPct70 | 100

The threshold for the volume of traffic coming to the property.<br> For example - setting a traffic volume percentage of 70 will draw a polygon that includes at least 70% of the visitors’ home location, where 100 will consider all CBGs visited from to the requested POI

Example response

{
  "startDate": "2020-12-01",
  "endDate": "2021-05-31",
  "apiIds": [
    "venue:7d55054520e387813d764b03"
  ],
  "location": "Home",
  "granularity": "month",
  "trafficVolPct": 70,
  "visitsByCBGs": [
    {
      "apiId": "venue:7d55054520e387813d764b03",
      "dates": [
        "2020-12-01",
        "2021-01-01",
        "2021-02-01",
        "2021-03-01",
        "2021-04-01",
        "2021-05-01"
      ],
      "visitsByCBGsTrend": [
        [
          {
            "CBGCode": 360470163003,
            "visits": 2859.0998658824965
          },
          {
            "CBGCode": 360471122002,
            "visits": 1964.8362800193345
          }
        ],
        [
          {
            "CBGCode": 360471214002,
            "visits": 3428.9773043774903
          },
          {
            "CBGCode": 360471130002,
            "visits": 1552.924740122248
          }
        ],
        [
          {
            "CBGCode": 360471196003,
            "visits": 2557.0424557126844
          },
          {
            "CBGCode": 360471122002,
            "visits": 1390.5306827296477
          }
        ],
        [
          {
            "CBGCode": 360470886002,
            "visits": 2625.74170877762
          },
          {
            "CBGCode": 360471196003,
            "visits": 2866.8235103927195
          }
        ],
        [
          {
            "CBGCode": 360470163003,
            "visits": 3483.2945180135303
          },
          {
            "CBGCode": 360471196003,
            "visits": 3821.0165325827234
          }
        ],
        [
          {
            "CBGCode": 360471196003,
            "visits": 3815.7833289048413
          },
          {
            "CBGCode": 360470163003,
            "visits": 3087.490216778003
          }
        ]
      ],
      "visitDurationSegmentation": "10MinOrLonger"
    }
  ]
}