---
title: "Visit by CBGs Report"
method: POST
path: "/v1/reports/visit-metrics/cbgs"
tags: ["Visits Reports"]
---

# Visit by CBGs Report

`POST /v1/reports/visit-metrics/cbgs`

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>&#x21e1; This service supports bulk request</strong><br/><br/> <strong>&#128205; 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

## Request body

- VisitsByCbgModel
  - `startDate` string, date, required — Queried data start date. Format YYYY-MM-DD
  - `endDate` string, date, required — Queried data end date. Format YYYY-MM-DD
  - `apiIds` ApiId[], 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
  - `trafficVolPct` 70 | 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

## Response `200`

200 response

- VisitsByCbgResponse
  - `startDate` string, date, required — Queried data start date. Format YYYY-MM-DD
  - `endDate` string, date, required — Queried data end date. Format YYYY-MM-DD
  - `apiIds` ApiId[], 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
  - `trafficVolPct` 70 | 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
  - `visitsByCBGs` object[] — Array of visits by CBGs insights broken down by apiIds
    - `apiId` string — Placer API Entity Id
    - `dates` string[] — Array of start days of each bin based on the granularity
    - `visitsByCBGsTrend` array[] — An Array that provides the visits per each CBG for the defined granularity broken down by the apiIds(corresponding to the apiIds array). <br>The data is presented as array objects corresponding to the dates array, where for each defined a nested array of coupled CBGcode-visits, that were observed during the relevant time period.
      - object[]
        - `CBGcode` integer — The CBG code
        - `visits` number, float — The estimated visits to the POI from the CBG for the corresponding bin period
    - `visitDurationSegmentation` 'under10Min' | '10MinOrLonger' | 'allVisits' | 'mixedSegments', nullable — The default visit duration segmentation is returned when the report calculation uses the default segmentation duration.

## Other responses

- `202` — 202 Accepted
- `400` — 400 Bad Request
- `403` — 403 Permission Denied
- `500` — 500 Internal Server Error

---

[API](https://skmtc.net/placer/apis/papi.md) · [All operations](https://skmtc.net/placer/apis/papi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/placer/papi/revisions/e317a0bbbd11/schema)