OperatingLocationRank

Description

Indicates how the card revenue of this operating location compares to other operating locations of the same enigma industry within the geographical area.

For example, if Joe's Pizza has a position of 5 and cohort size of 17, this means, of all the pizza restaurants near Joe's Pizza, four locations have higher card revenue and twelve locations have lower card revenue.

The geographic area is defined as the H3 index (resolution 4) of the address of the operating location.

There are a few reasons why an operating location does not have an operating location rank * we're unable to determine the card revenue for the operating location * fewer than ten operating locations with card revenue exist nearby within the same industry (too few businesses to form a cohort)

type OperatingLocationRank implements MathFunctions {
  id: UUID!
  firstObservedDate: String
  lastObservedDate: String
  quantityType: String
  period: String
  position: Int
  cohortSize: Int
  periodStartDate: Date
  periodEndDate: Date
  internalId: String
  internalOperatingLocationId: String
  count(
    field: String!
    conditions: Conditions
  ): Int
  sum(
    field: String!
    conditions: Conditions
  ): Int
  min(
    field: String!
    conditions: Conditions
  ): Int
  max(
    field: String!
    conditions: Conditions
  ): Int
  avg(
    field: String!
    conditions: Conditions
  ): Float
  collect(
    field: String!
    separator: String
    conditions: Conditions
  ): String
  minDateTime(
    field: String!
    conditions: Conditions
  ): DateTime
  maxDateTime(
    field: String!
    conditions: Conditions
  ): DateTime
}

Fields

`OperatingLocationRank.id` ● `UUID!` non-null scalar

`OperatingLocationRank.firstObservedDate` ● `String` scalar

`OperatingLocationRank.lastObservedDate` ● `String` scalar

`OperatingLocationRank.quantityType` ● `String` scalar

The quantity we're using to determine the ranking within a cohort. At present, ranks will always be based on card_revenue.

`OperatingLocationRank.period` ● `String` scalar

The period we're using to determine the ranking within a cohort. At present, ranks will always be based on the most recent 12m for which revenue is available.

`OperatingLocationRank.position` ● `Int` scalar

The absolute position of the operating location relative to its cohort. So if Joe's Pizza is ranked 5 out of 17 for area pizza restaurants, the position will equal 5.

`OperatingLocationRank.cohortSize` ● `Int` scalar

The number of operating locations in the cohort. For our Joe's Pizza example (5 of 17), the cohort size is 17.

`OperatingLocationRank.periodStartDate` ● `Date` scalar

The date on which the *period* begins. So if *period_start_date* is 2024-01-15 and period is 12m, this means the 12m period we're using to rank the operating location began on Jan 15, 2024.

`OperatingLocationRank.periodEndDate` ● `Date` scalar

The date on which the *period* ends. So if *period_end_date* is 2025-01-15 and period is 12m, this means the 12m period we're using to rank the operating location ends on Jan 15, 2025.