Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Ranking Reports

Ranking Metrics For Multiple Properties

Returns the <glossary:Ranking> for all the requested entities within a selected scope :<br/> <ul> <li> Chain scope - compares each entity <glossary:Ranking> vs all other chain’s entities.</li> <li>Group category scope - compares each entity <glossary:Ranking> vs all venues under the selected group category (Apparel, Leisure, …).</li> <li>Category scope - compares each entity <glossary:Ranking> vs all venues under the selected category (Regional Mall, Industrial, …).</li> </ul> The service supports <glossary:Ranking> based on pre-defined periods. (In case a custom date range is required use /reports/ranking-overview endpoint).<br/><br/><strong>⇡ This service supports bulk request</strong><br/>

⏱ <strong>Average measured processing time: 3.58 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: <<glossary:Flagged entities>> will not be taken into consideration in the resulting report

post/v1/reports/ranking-overview/multi

Request body

apiIdsApiId[] required
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

Example request

{
  "apiIds": [
    "venue:7d55054520e387813d764b03"
  ],
  "period": "lastWeek",
  "scope": "category",
  "metric": "visits"
}

Response

200 response

apiIdstring

Placer API Entity Id

metricTypestring
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'.

Example response

[
  {
    "apiId": "venue:7d55054520e387813d764b03",
    "metricType": "visits",
    "info": {
      "name": "Walmart",
      "entityId": "7d55054520e387813d764b03",
      "entityType": "venue",
      "rankedBy": "chain",
      "categoryInfo": {
        "category": "Fast Food & QSR",
        "group": "Dining",
        "subCategory": "Pizze Place"
      }
    },
    "ranking": {
      "nationwide": {
        "rank": 4,
        "percentile": 85,
        "rankedOutOf": 1850,
        "regionCode": "US"
      },
      "state": {
        "rank": 4,
        "percentile": 85,
        "rankedOutOf": 1850,
        "regionCode": "CA"
      },
      "dma": {
        "rank": 4,
        "percentile": 85,
        "rankedOutOf": 1850,
        "regionCode": "510"
      },
      "cbsa": {
        "rank": 4,
        "percentile": 85,
        "rankedOutOf": 1850,
        "regionCode": "34980"
      }
    },
    "visitDurationSegmentation": "10MinOrLonger"
  }
]