--- title: "Visitor Journey - Favorite Chains" method: POST path: "/v1/reports/favorites-chains" tags: ["Visitor Journey Reports"] --- # Visitor Journey - Favorite Chains `POST /v1/reports/favorites-chains` Favorite <> provides a list of other <> that visitors to your location have also visited during the selected time frame (e.g., X% of visitors to My Venue also visited Chain A during the last X months).
You may choose specific categories to examine among the listed categories and define the minimum visit frequency.
The response includes the top 50 properties matching the requested parameters.



⏱ Average measured processing time: 4.46 seconds
For more information on request retries best practices and processing measurements you may visit this page

📍 This service supports the <>. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic. ## Request body - FavoriteRequest - `startDate` string, date, required — Queried data start date. Format YYYY-MM-DD - `endDate` string, date, required — Queried data end date. Format YYYY-MM-DD - `apiId` string, required — Placer API Entity Id - `categories` string[] — Array of categories to which the resulted favorite places are associated. “all” will be used as default.
NOTE: please select the specific categories from the listed categories.
If a list of categories is provided yet only some categories are recognized, results will reflect only the recognized categories. In case no category is recognized the results will reflect all categories. - `minimalVisitFrequency` integer — The minimal visits frequency requested in the other places/<>. 1 will be used as default. - `limit` integer — The number of expected results. Default is set to 50. - `filters` VmFilterObject — Filtering options for the report results. - `audienceType` string[] — If provided - metrics will be calculated based only on the specified types of audience. - `dwellTime` object — Metrics will be calculated considering the requested dwell time range. - `operator` '<' | '>=' — Less than (<) to Greater Equal (>=) - `value` integer — The wanted dwell time - `hoursRange` object — Filter the report’s results based on visits hours range. The filter is defined by 2 strings:
1. The starting hour to filter the reports results from (Format HH:MM XM, for example: 08:00 am).
2. The end hour to filter the reports results(Format HH:MM XM, for example: 11:59 pm) . - `fromHour` string, required - `toHour` string, required - `daysOfWeek` unknown[] — Filter visit calculation based on days of the week. Results will contain only requested days. Days are represented by using numbers where Monday=1 and Sunday=7. For example: in order to retrieve weekend days use the following [ 6, 7 ]. - unknown - `distance` object — Filter visits by distance in miles from home or work
where only visits in a given radius will be used in metrics calculation. - `from` 'home' | 'work' — The origin from where the distance will be measured. - `values` object — Object representation of the distance range
lt - less than
le - less than or equal to
eq - equal to
ge - greater than or equal to
gt - greater than. - `le` number - `ge` number - `lt` number - `gt` number - `eq` number - `nearbyRadius` 100 | 250 | 500 | 750 | 1000 — The radius requested for nearby activity report generation.
Note: When a value is populated for this attribute - the report will be calculated as per the <> logic. ## Response `200` 200 response - FavoriteChainsResponse - `requestedCategories` string[] — The list of requested categories - `nearbyRadius` 100 | 250 | 500 | 750 | 1000 — The radius requested for nearby activity report generation.
Note: When a value is populated for this attribute - the report will be calculated as per the <> logic. - `filters` ResponseFilters - `audienceType` string[] — The list of audiences that is specified in the request filter. - `dwellTime` object — The dwell time filter specified in the request, in case it was utilized.
For example: “< 100” or “>= 10” - `operator` '<' | '>=' — Represents the operator used for defining the dwell time range for filtering the report data - `value` integer — Represents the number of minutes referred to when defining the dwell time range for filtering the report data - `hoursRange` object — The hours range that is specified in the request filter. - `fromHour` string — Start visits hour (Format HH:MM XM, for example: 08:00 am) - `toHour` string — End visitation hour (Format HH:MM XM, for example: 08:00 am) - `daysOfWeek` unknown[] — A list of days represented by integers (Monday=1, Sunday=7) as specified in the request filter, which was used in the report calculation. - unknown - `distance` object — The visits considered for the report calculation by distance in miles from home or work as specified in the request filter. - `from` 'home' | 'work' — The origin from where the distance will be measured. - `values` object — Object representation of the distance range
lt - less than
le - less than or equal to
eq - equal to
ge - greater than or equal to
gt - greater than. - `le` number - `ge` number - `lt` number - `gt` number - `eq` number - `visitDurationSegmentation` 'under10Min' | '10MinOrLonger' | 'allVisits' | 'mixedSegments', nullable — The default visit duration segmentation is returned when the report calculation uses the default segmentation duration. - `favoritesChainsArray` FavoriteChainsInfo[] — The list of most visited chains by the visitors to the requested POI - `apiId` string — Placer API Entity Id - `name` string — Entity Name - `entityId` string — Entity ID - `entityType` 'venue' | 'complex' | 'chain' — Entity Type (i.e. venue, complex etc.) - `categoryInfo` CategoryInfo — Property’s categorization - `category` string - `group` string - `subCategory` string - `regionType` string - `estimatedNumberOfCustomers` integer — Estimated foot traffic during the requested period, when associated with visitation to the queried POI - `percentage` number, float — The percentage of visitors to the requested venue also visited this property during the requested period ## Other responses - `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)