# Placer Documentation > Documentation for Placer ## Guides - [Welcome to Placer Feeds!](https://docs.placer.ai/docs/welcome-to-placers-feeds.md) - [Delivery Details](https://docs.placer.ai/docs/delivery-details.md) - [Storage Requirements](https://docs.placer.ai/docs/storage-requirements.md) - [Access feeds via Snowflake](https://docs.placer.ai/docs/access-feeds-via-snowflake.md) - [Amazon Simple Notification Service setup](https://docs.placer.ai/docs/amazon-simple-notification-service-setup.md) - [Points of Interest Metadata](https://docs.placer.ai/docs/poi-metadata.md) - [Premium Export](https://docs.placer.ai/docs/premium-export.md) - [Origins](https://docs.placer.ai/docs/origins-feed.md) - [Same-Store Visits](https://docs.placer.ai/docs/same-store.md) - [Chain Visit Forecast](https://docs.placer.ai/docs/chain-visit-forecast.md) - [Brand Sourcing](https://docs.placer.ai/docs/brand-sourcing.md): Easily identify rapidly growing or shrinking retail brands. - [Commercial Mortgage-Backed Security Feed](https://docs.placer.ai/docs/commercial-mortgage-backed-security-feed.md) - [Migration Trends](https://docs.placer.ai/docs/migration-trends.md): v4.0 - [Migration Trends FAQs](https://docs.placer.ai/docs/migration-trends-v4-faqs.md) - [FAQs](https://docs.placer.ai/docs/faqs.md) - [Venue Categories](https://docs.placer.ai/docs/categories.md) ## API Reference - [Welcome to PAPI](https://docs.placer.ai/reference/welcome-to-papi.md): Access Placer Data Programmatically - [Search for Placer Entities](https://docs.placer.ai/reference/get_v1-poi-1.md): This service returns a list of Placer managed entities in a particular area. You can search based on any combination of the following filter parameters:
entities within a specific location radius, entities associated with a specific group category/category/sub category, entity name or type.
The response lists the matched entities, including address and location, zip code, group category, category ,sub-category and a link to Placer dashboard.
The service supports pagination using the skip parameter. The first 1000 entities matching the criteria of the request are available.
For available categories, see listed categories.

Note that when using the radius parameter, the actual area being considered for searching POIs is the area within a square that is bounding the circle, which is defined by the requested radius.
Please note: In case you receive results where the isPermitted attribute is set to “false”, that means that you are not permitted to run reports for those. In case you wish to extend your permissions please contact customer support. - [Get Sub-Entities for a complex, a chain or a tag](https://docs.placer.ai/reference/get_v1-poi-id-entities-1.md): Returns a list of sub-entities for given api ID. Sub-entities can be associated with <>, <> and <> . <> and <> contain venues as their sub-entities while <> may have venues, <> or <>

✽ This service supports chain level requests. - [Get Listed Entities for Account.](https://docs.placer.ai/reference/get_v1-poi-my-properties-1.md): Returns a list of entities for a given account.The response will include all entities which are under the Property tag (i.e. Portfolio). - [Create Custom POI](https://docs.placer.ai/reference/post_v1-poi-custom-poi-1.md): The create <> endpoint can be used to generate custom POIs by specifying the unique polygons to analyze.
The <> can be generated by either specifying the combination of centroid (lng, lat) and mile radius to draw the POI's area, or by using GEOJson which includes a list of all polygon GEO points (lng, lat).
This endpoint runs duplication checks on each call in order to ensure that the same <> is not created more than once. If a <> is already created the return code will display a wrong request (http-code=400) specifying the previously created API ID.
Please be aware that creating custom POIs might take longer than 30 seconds, which falls within the timeout window. During such occurrences, the HTTP response code will be 202 (i.e., In progress), along with the apiId of the partially created POI. You can monitor the creation status by querying the Get Custom POI endpoint. - [Get Custom POI Info](https://docs.placer.ai/reference/get_v1-poi-custom-poi-id-1.md): The Get Custom POI Info service can be used to retrieve information regarding any of your <>s, by providing its id.
If the requested Custom POI is newly created, this endpoint will respond with the following statuses:
- **HTTP code = 200**: The full response for the Get Custom POI is provided.
- **HTTP code = 202**: The creation process is still in progress.
- **HTTP code = 404**: The POI does not exist, indicating a failure in the creation process. Please retry creating the custom POI.
- **HTTP code = 500**: Server error. - [Update Custom POI](https://docs.placer.ai/reference/put_v1-poi-custom-poi-id-1.md): The Update POI service can be used to update any of your <>s, by providing any combination of the following custom POI’s properties(at least one):
  1. Name - the POI’s name.
  2. Area - can be defined either by determining the centroid (lng, lat) and the radius to create the POI area, or by a list of all polygon GEO points (lng,lat).
  3. Sub-category (For available sub-categories, see listed categories.
  4. Address - the consumer can change any of the following properties: street address, city and/or zipcode.
- [Delete Custom POI](https://docs.placer.ai/reference/delete_v1-poi-custom-poi-id-1.md): This service allows developers to delete a custom POI by its apiId. - [Create a new tag](https://docs.placer.ai/reference/post_v1-poi-tags-1.md): Using this service, you have the capability to generate a fresh tag for organizing entities according to your specific business needs. - [Add POI List to an Existing Tag](https://docs.placer.ai/reference/put_v1-poi-tags-1.md): This service can be used to attach entities to an existing tag. - [Remove POI List From an Existing Tag](https://docs.placer.ai/reference/delete_v1-poi-tags-1.md): This service can be used to detach entities from an existing tag. - [Visit Metrics Summary Report](https://docs.placer.ai/reference/post_v1-reports-visit-metrics-1.md): Retrieves visitors and visits for a given list of entities.
This endpoint supports bulk requests up to 100 entities

⇡ This service supports bulk request
When nearbyRadius is set, a report will be generated for the first entity in the array only.

⏱ Average measured processing time: 10 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

- [Visits by Hours Report](https://docs.placer.ai/reference/post_v1-reports-visit-metrics-hours-1.md): Retrieves visits for a given entity(venue/complex) broken by the hours of the day and its business opening hours.

The response includes:
  • 2 arrays:
    1. Hour of the day bins: [0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23], where each represents an hour in the day. (e.g. 11 = 11 am - 12 pm)
    2. Estimated foot traffic array: Indicates the total visits for the POI during the selected date range for each of the hour bins (correlated to the location in the Hour of the day array)
  • Array of the business opening hours for each day of the week.

⏱ Average measured processing time: 0.79 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. - [Visits by Days Report](https://docs.placer.ai/reference/post_v1-reports-visit-metrics-days-1.md): Retrieves visits for a given entity(venue/complex/billboard) broken by the days of the week.

The response includes 2 arrays:
  1. Day of the week bins : [0,1,2,3,4,5,6], where each represents a day of the week. (i.e. Mon.-Sun.).
  2. Indicates the total visits for the POI during the selected date range for each of the day of the week bins (correlated to the location in the Day of the week array)

⏱ Average measured processing time: 0.72 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. - [Visits by Dwell Time Report](https://docs.placer.ai/reference/post_v1-reports-visit-metrics-dwell-time-1.md): Retrieves visits for a given entity(venue/complex) broken by dwell time periods.

The response includes:
  1. Dwell time bins array: [0,5,15,30,45,60,75,90,105,120,135,150] (I.e. 5 represents 5-14 minutes, 150 represents all visits with dwell time higher than or equal to 150)
  2. Estimated foot traffic array: Indicates the total visits for the POI during the selected date range for each of the dwell time bins (correlated to the location in the dwell time bins array)
  3. Average dwell time
  4. Median dwell time

⏱ Average measured processing time: 0.77 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. - [Visit by CBGs Report](https://docs.placer.ai/reference/post_v1-reports-visit-metrics-cbgs-1.md): 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.

⇡ This service supports bulk request

📍 This service doesn't support custom POI.

* Please note that sparsely populated CBGs may not be included in the feed to align with Placer's privacy policy.

For more information on request retries best practices and processing measurements you may visit this page - [Visit Trends Report](https://docs.placer.ai/reference/post_v1-reports-visit-trends-1.md): Retrieves visitations for a given list of entities in daily, weekly or monthly granularity.

⇡ This service supports bulk request

✽ This service supports chain level requests

⏱ Average measured processing time: 3.58 seconds

📍 This service doesn't support custom POI. To pull visits trend for custom POI please use Visit Trends Report for a Single Property endpoint.

For more information on request retries best practices and processing measurements you may visit this page - [Visit Trends Report for a Single Property](https://docs.placer.ai/reference/post_v1-reports-visit-trends-single-1.md): Retrieves visits for a given entity in daily, weekly or monthly granularity.

For more information on request retries best practices and processing measurements you may visit this page - [Visits by Frequency Report](https://docs.placer.ai/reference/post_v1-reports-loyalty-visits-frequency-1.md): This service enables you to learn about the frequency of visitations to the requested POI.
Insights are provided for all the below types of metrics, bucketed into visitations frequency bins (i.e. 1, 2, 3, …30+ visits per visitor):
  • Visitors - The estimated number of unique visitors to the POI
  • % of Visitors - The % of unique visitors that visited the POI
  • Visits - The estimated number of visits to the POI
  • % of Visits - The % of visits generated by visitors to the POI


📍 This service supports the <>. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic. - [Trade Area Report](https://docs.placer.ai/reference/post_v1-reports-true-trade-area-1.md): True Trade Areas are calculated by the volume of traffic reaching the venue or complex . For example, setting 'traffic vol' to 70% draws a polygon that represents 70% of the visitors’ home location.

⏱ Average measured processing time: 2.24 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. - [Trade Area by Drive Time Report](https://docs.placer.ai/reference/post_v1-reports-trade-area-drive-time-1.md): This service lets you retrieve the trade area polygon calculated for a specified drive time.

📍 This service supports the <>. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic. - [Trade Area Demographics Profile Report](https://docs.placer.ai/reference/post_v1-reports-trade-area-demographics-1.md): Returns trade area demographics. By default returns potential demographics (population living in the trade area). Set audienceType to captured in the request body to get captured demographics (home-CBG demographics of actual visitors).
Supported datasets to use are:
  • Census: ACS (2024)
  • STI: Popstats
  • STI: Landscape
  • STI: Market Outlook
  • STI: Spending Patterns
  • STI: Workplace
  • Spatial.ai:PersonaLive
  • Spatial.ai:FollowGraph
  • Experian:Mosaic

Datasets are available based on your account's settings

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

NOTE: <> will not be taken into consideration in the resulting report

📍 This service supports the <>. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic. - [Ranking Metrics for a Single Property](https://docs.placer.ai/reference/post_v1-reports-ranking-overview-1.md): This service returns the specific entity <> within a selected scope :
  • Chain scope - compares the entity <> vs all other chain’s entities
  • Group category scope - compares the entity <> vs all venues under the selected group category (Apparel, Leisure, …).
  • Category scope - compares the entity <> vs all venues under the selected category (Regional Mall, Industrial, …).

The endpoint supports the option to have a custom date range (as well as pre-defined time buckets) and <> within a local area ( 5,10,15 miles).
⏱ Average measured processing time: 8.57 seconds
For more information on request retries best practices and processing measurements you may visit this page

NOTE: <> will not be taken into consideration in the resulting report. - [Ranking Metrics For Multiple Properties](https://docs.placer.ai/reference/post_v1-reports-ranking-overview-multi-1.md): Returns the <> for all the requested entities within a selected scope :
  • Chain scope - compares each entity <> vs all other chain’s entities.
  • Group category scope - compares each entity <> vs all venues under the selected group category (Apparel, Leisure, …).
  • Category scope - compares each entity <> vs all venues under the selected category (Regional Mall, Industrial, …).
The service supports <> based on pre-defined periods. (In case a custom date range is required use /reports/ranking-overview endpoint).

⇡ This service supports bulk request
⏱ Average measured processing time: 3.58 seconds
For more information on request retries best practices and processing measurements you may visit this page

NOTE: <> will not be taken into consideration in the resulting report - [Ranking Index - Top Ranked](https://docs.placer.ai/reference/post_v1-reports-ranking-index-top-ranking-1.md): Generate a ranked list of properties relative to a benchmark based on the one of following segments:
  • Within Chain - ability to reach all chain’s venues ranked from the top most to the last using pagination.
  • Within Category/Group Category - ability to fetch up to 1000 top ranked properties within the same Category/group category of the requested property.
Provides view by different metrics and regions.
Metrics
  • Visits: shows the <> according to the estimated number of visits to the POI.
  • Visits / Sq ft: shows the <> according to the estimated number of visits relative to the total square footage of a property.
Regions
  • nationwide: The nationwide <> of a POI benchmarked against POIs from the same category or chain.
  • state/dma/cbsa: The ranking benchmarked against POIs from the same category or chain in the POI's state/dma/cbsa.
  • Specific distance: The POI’s <> benchmarked against POIs from within a 5 / 10 / 15 / 30 / 50 miles radius.


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

NOTE: <> will not be taken into consideration in the resulting report. - [Ranking Index - Closely Ranked](https://docs.placer.ai/reference/post_v1-reports-ranking-index-closely-ranked-1.md): This endpoint generates a ranked list of properties relative to a benchmark based on the one of following segments:
  • Within Chain - Provides other closely ranked venues within the same chain.
  • category - provides the <> within the venue’s category
  • Within Category/Group Category - Provides other closely ranked venues within the same category/group category.
Provides view by different metrics and regions.
Metrics:
  • Visits: shows the <> according to the estimated number of visits to the POI.
  • Visits / Sq ft: shows the <> according to the estimated number of visits relative to the total square footage of a property.

Regions:
  • nationwide: The nationwide <> of a POI benchmarked against POIs from the same category or chain.
  • state/dma/cbsa: The Ranking benchmarked against POIs from the same category or chain in the POI's state/dma/cbsa.
  • Specific distance: The POI’s Ranking benchmarked against POIs from within a 5 / 10 / 15 / 30 / 50 miles radius.
You may define the total number of results to display (up to 1000), whereby half of the results will reflect properties ranked higher than the requested property and half of the results will reflects the ones ranked lower. For example: if the requested POI is ranked 550 and results amount value is set to 200 - then the response includes all properties ranked between 450 and 649 within the indexed list.
The endpoint supports pre-defined time buckets and ranking regions.

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

NOTE: Flagged entities will not be taken into consideration in the resulting report. - [Visitor Journey - Favorite Places](https://docs.placer.ai/reference/post_v1-reports-favorites-places-1.md): Favorite Places provides a list of other places that visitors to your location have also visited during the selected time frame (e.g., X% of visitors to My Venue also visited Place 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. - [Visitor Journey - Favorite Chains](https://docs.placer.ai/reference/post_v1-reports-favorites-chains-1.md): 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. - [Retail Sales Trend Report](https://docs.placer.ai/reference/post_v1-reports-retail-sales-sales-trends-1.md): This service provides the insights about sales performance at each venue examined in the report. Within the response of this service you will be receiving both the requested insights based on the date range, granularity and type of metric, and the annual sales for the past year-to-date and 3 last calendar years.

Note: Retail sales data currently excludes online transactions and only pertains to sales in brick and mortar locations. Transactions which occurred using the Buy Now Pick Up In Store option may be reflected in the data, depending on the retailer concerned. In the event that Retail Sales data is not available for the report’s entire date range the response will provide the exact dates for which the data applies. - [Retail Sales Overview](https://docs.placer.ai/reference/post_v1-reports-retail-sales-overview-1.md): This service provides the retail sales metrics overview for the entire requested period.

Note: Retail sales data currently excludes online transactions and only pertains to sales in brick and mortar locations. Transactions which occurred using the Buy Now Pick Up In Store option may be reflected in the data, depending on the retailer concerned. In the event that Retail Sales data is not available for the report’s entire date range the response will provide the exact dates for which the data applies. - [Retail Sales Daily Trends](https://docs.placer.ai/reference/post_v1-reports-retail-sales-days-1.md): This service provides the retail sales metrics overview for the entire requested period aggregated either by the day of the week or by weekdays/weekend. The insights are available for various of metrics:
  • sales: The dollar value (USD) of all sales during your selected aggregation.
  • avg_sales: The dollar value (USD) of average sales per day during your selected aggregation.
  • sales_pct: The percentage of total sales which occurred during your selected aggregation.
  • sales_sq_ft: The total value of sales per square foot at the venue examined, during your selected aggregation.
  • transactions: The total number of individual transactions which took place at the property examined during your selected aggregation.
  • transactions_pct:The percentage of total transactions which occurred during your selected .aggregation.
  • avg_ticket_size: The average dollar amount of sales per transaction generated at the venues in your report, per your selected aggregation.
Note: Retail sales data currently excludes online transactions and only pertains to sales in brick and mortar locations. Transactions which occurred using the Buy Now Pick Up In Store option may be reflected in the data, depending on the retailer concerned. In the event that Retail Sales data is not available for the report’s entire date range the response will provide the exact dates for which the data applies. - [Retail Sales Transactions Trends Report](https://docs.placer.ai/reference/post_v1-reports-retail-sales-transaction-trends-1.md): The Transaction Trend presents the total number of transactions generated at the venues in your report over time. You can compare the venue's transaction trend against its category or chain average.

Note: Retail sales data currently excludes online transactions and only pertains to sales in brick and mortar locations. Transactions which occurred using the Buy Now Pick Up In Store option may be reflected in the data, depending on the retailer concerned. In the event that Retail Sales data is not available for the report’s entire date range the response will provide the exact dates for which the data applies. - [Retail Sales Average Ticket Size Trend Report](https://docs.placer.ai/reference/post_v1-reports-retail-sales-avg-ticket-size-trends-1.md): Average Ticket Size report allows you to examine the average dollar amount of sales per transaction generated at the venue in your report, during the selected date range. You can compare the venue's average ticket size trend against its category average.

Note: Retail sales data currently excludes online transactions and only pertains to sales in brick and mortar locations. Transactions which occurred using the Buy Now Pick Up In Store option may be reflected in the data, depending on the retailer concerned. In the event that Retail Sales data is not available for the report’s entire date range the response will provide the exact dates for which the data applies. - [Account Usage](https://docs.placer.ai/reference/get_v1-accounts-keys-usage-status-1.md): Retrieves the current API usage status for the requesting API key.
This endpoint helps you monitor consumption and remaining quota. Running it 2–3 times per week is recommended for optimal tracking usage patterns.
Note:
  • The weekly quote renewals occur every Sunday at 12:00 a.m. UTC.
  • There can be a discrepancy between usedQuota and the sum of calls made to individual endpoints because only successful calls are counted.
- [Getting started](https://docs.placer.ai/reference/getting-started.md): Placer.ai offers partners a set of REST API calls for retrieving data from its internal repositories. This guide shows you how to set up access to Placer REST API (PAPI), configure the environment, and invoke the API methods using HTTP requests. - [Glossary](https://docs.placer.ai/reference/glossary.md): A guide to understanding various terms used in the Placer ecosystem and the Placer API - [Reports Processing Time](https://docs.placer.ai/reference/measurements.md) - [Versioning](https://docs.placer.ai/reference/versioning.md) - [Errors & Troubleshooting](https://docs.placer.ai/reference/error-codes-2.md) - [FAQs](https://docs.placer.ai/reference/faqs-1.md) ## Changelog - [Feed Delivery Updates - Coming March 6, 2025](https://docs.placer.ai/changelog/feed-delivery-updates-coming-march-6-2025.md) - [Latest Demographic Data: U.S. Census ACS 2023 & STI Popstats 2024 Available](https://docs.placer.ai/changelog/latest-demographic-data-us-census-acs-2023-sti-popstats-2024-available.md) - [v1.2.1 - January release updates](https://docs.placer.ai/changelog/v121-january-release-updates.md) - [Data version 2.1 - API enhancements](https://docs.placer.ai/changelog/data-version-21-releasing-to-the-api.md) - [Data version 2.1 - Feeds adjustments](https://docs.placer.ai/changelog/data-version-21-feeds-adjustments.md)