Ranking Index - Top Ranked

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 Ranking according to the estimated number of visits to the POI.
  • Visits / Sq ft: shows the Ranking according to the estimated number of visits relative to the total square footage of a property.
Regions
  • nationwide: The nationwide Ranking 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.


Average measured processing time: 2.71 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Placer API Entity Id

enum
required
Defaults to 15

Region to be set for ranking index

string | null
enum
required

The time period for which the Ranking will be calculated. Cannot be used along with startDate and endDate

string
enum
required
Defaults to category
Allowed:
string
enum
required
Defaults to visits
Allowed:
integer
0 to 1000
Defaults to 100

Number of records to be fetched

integer
≥ 0
Defaults to 0

Relevant for the chain scope only. Contains 0 in the first call, and the offset for pagination in next calls, default set to 0.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json