Token needs the read ability. About tokens

Query parameters

• period Period required
  current yesterday last_week last_month last_90_days last_tenant_period ytd
• metric string required
  Metric key, e.g. net_sales_amount, custom:loyalty_signups, or competition:spring_challenge. Competition metrics rank locations by their current cumulative standing in the latest competition for that metric; the requested period does not change the competition window.
• source Source
  google yelp store_audit ecosure smg meazureup decision_logic
• district_id string (uuid)
• district_id_2 string (uuid)
• location_category_id string (uuid)
• state string

Responses

• 200 Success
  • data Leaderboard
    Show 12 properties
    • period string required nullable
    • metric string required nullable
    • source string required nullable
    • starts_on string (date) required nullable
    • ends_on string (date) required nullable
    • num_locations integer required
    • closed_location_count integer required
      How many closed (deactivated) locations total counts beyond the ranked rows. A location that closed during the window still traded in it, so total includes its sales for the days it was open; it never appears in locations, and mean / median describe open locations only. Summing the rows reproduces total only when this is 0.
    • total number required nullable
    • median number required nullable
    • mean number required nullable
    • benchmark_stats object required
      Board-level aggregates of each benchmark window, keyed prior / yoy. The response always carries every comparison the tenant is ready for — there is no parameter to request one — so yoy is absent until the tenant has a year of history, and the map is an empty object when the metric supports no comparison at all.
      Show 2 properties
      • prior LeaderboardBenchmarkStats
        Show 5 properties
        • total number required nullable
        • median number required nullable
        • mean number required nullable
        • location_count integer required
          How many locations these aggregates cover: every location that reported in the benchmark window. This can exceed the number of locations rows carrying a previous_value, since a location that reported only in the benchmark window has no row in the current one, so summing the rows' previous values need not reproduce total. Includes closed_location_count.
        • closed_location_count integer required
          How many of location_count are locations that have since closed. total counts their sales in the benchmark window; mean and median do not.
      • yoy LeaderboardBenchmarkStats
        Show 5 properties
        • total number required nullable
        • median number required nullable
        • mean number required nullable
        • location_count integer required
          How many locations these aggregates cover: every location that reported in the benchmark window. This can exceed the number of locations rows carrying a previous_value, since a location that reported only in the benchmark window has no row in the current one, so summing the rows' previous values need not reproduce total. Includes closed_location_count.
        • closed_location_count integer required
          How many of location_count are locations that have since closed. total counts their sales in the benchmark window; mean and median do not.
    • locations array of LeaderboardLocation required
      Show 5 properties
      • location_id string required
      • name string required
      • value number required nullable
      • rank integer required
      • benchmarks object required
        This location's comparison against each benchmark window, keyed prior / yoy like benchmark_stats. A key is absent when this location has no data in that window; the map is an empty object when no comparison was made.
        Show 2 properties
        • prior LeaderboardBenchmark
        • yoy LeaderboardBenchmark
• 401 Authentication failed or missing.
  • message string
• 403 The token lacks the required ability or the caller is not permitted.
  • message string