---
title: "Ranking Index - Closely Ranked"
method: POST
path: "/v1/reports/ranking-index/closely-ranked"
tags: ["Ranking Reports"]
---

# Ranking Index - Closely Ranked

`POST /v1/reports/ranking-index/closely-ranked`

This endpoint generates a ranked list of properties relative to a benchmark based on the one of following segments:<br/> <ul> <li>Within Chain - Provides other closely ranked venues within the same chain.</li> <li>category - provides the <<glossary:Ranking>> within the venue’s category</li> <li>Within Category/Group Category - Provides other closely ranked venues within the same category/group category.</li> </ul> Provides view by different metrics and regions.<br/> Metrics:<br/> <ul> <li>Visits: shows the <<glossary:Ranking>> according to the estimated number of visits to the POI.</li> <li>Visits / Sq ft: shows the <<glossary:Ranking>> according to the estimated number of visits relative to the total square footage of a property.</li> </ul> </br> Regions:</br> <ul> <li>nationwide: The nationwide <<glossary:Ranking>> of a POI benchmarked against POIs from the same category or chain.</li>
<li>state/dma/cbsa: The Ranking benchmarked against POIs from the same category or chain in the POI's state/dma/cbsa.</li>
<li>Specific distance: The POI’s Ranking benchmarked against POIs from within a 5 / 10 / 15 / 30 / 50 miles radius.</li> </ul> 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 <b>results amount</b> value is set to 200 - then the response includes all properties ranked between 450 and 649 within the indexed list.</br> The endpoint supports pre-defined time buckets and ranking regions.</br><br/>
&#x23F1; <strong>Average measured processing time: 3.98 seconds </strong><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<br/><br/>
NOTE: Flagged entities will not be taken into consideration in the resulting report.

## Request body

- RankingIndexCloselyRankedRequest
  - `apiId` string, required — Placer API Entity Id
  - `region` '5' | '10' | '15' | '30' | '50' | 'nationwide' | 'state' | 'dma' | 'cbsa', required — Region to be set for ranking index
  - `period` 'last3Months' | 'last6Months' | 'last12Months' | 'lastWeek' | 'lastMonth' | 'lastQuarter' | 'yearToDate' | 'year2018' | 'year2019' | 'year2020' | 'year2021' | 'year2022' | 'year2023' | 'year2024' | 'year2025', nullable, required — The time period for which the <<glossary:Ranking>> will be calculated. Cannot be used along with startDate and endDate
  - `scope` 'chain' | 'category' | 'groupCategory', required
  - `metric` 'visitsPerSqft' | 'visits', required
  - `resultsAmount` integer — The amount of results returned in the response - half of the results are the properties which are ranked higher than the requested property, and half are ranked lower. By default 100 results will be retrieved.

## Response `200`

200 response

- union
  - RankingIndexResponse
    - `totalRanked` integer — The total number of properties within the scope and region selected, from which the <<glossary:Ranking>> will be conducted. For example: the requested property is ranked 550 out of 7500 (= total number of records) properties within the same chain(= scope) in the same state(= region).
    - `rank` integer — The rank of the requested POI
    - `region` string — The requested region
    - `scope` string — The requested scope
    - `metricType` string — The requested metric
    - `visits` number — The estimated foot traffic at the requested property per the requested parameters
    - `rankingIndexArray` object[]
      - `apiId` string — Placer API Entity Id
      - `name` string
      - `address` RankingIndexAddress
        - `city` string — Entity City
        - `state` string — Entity State
        - `countryCode` string — Entity Country Code
        - `streetName` string — Entity Street Name
        - `formattedAddress` string — Entity Address
        - `shortFormattedAddress` string — Entity Address
        - `zipCode` string — Entity Zip Code
        - `country` string — Entity Country
        - `address` string — Entity Address
      - `rank` integer
      - `visits` number
    - `visitDurationSegmentation` 'under10Min' | '10MinOrLonger' | 'allVisits' | 'mixedSegments', nullable — Represents the requested visit duration segmentation.<br> If the default visit duration segmentation is requested, the visitDurationSegmentation will display the actual segment.<br> In cases where the default segment was requested for a chain, in which the list of entities used different default segments for the report calculation, the visitDurationSegmentation will be set to 'mixedSegments'.
  - RankingIndexError
    - `region` string — The requested region
    - `scope` string — The requested scope
    - `metricType` string — The requested metric
    - `rankError` string — The error that was occuerd while trying to get <<glossary:Ranking>> for that entity

## 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)