Ranking Metrics for a Single Property

This service returns the specific entity Ranking within a selected scope :

  • Chain scope - compares the entity Ranking vs all other chain’s entities
  • Group category scope - compares the entity Ranking vs all venues under the selected group category (Apparel, Leisure, …).
  • Category scope - compares the entity Ranking 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 Ranking 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: 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

The endpoint return the nationwide, state, CBSA, DMA and the local distance Ranking as selected in the query params.

string
required

Placer API Entity Id

date

The start date of the time period for which the Ranking will be calculated. Cannot be used along with period param

date

The end date of the time period for which the Ranking will be calculated. Cannot be used along with period param

integer
enum
Defaults to 15
Allowed:
string | null
enum

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:
Responses

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