Leaderboard

Use cases

Leaderboard visualization

Visualize leaderboard data in your apps.

Aggregated tables

Display aggregated data in tables.

Features

All the common API features, plus:

Group the results by one or more dimensions.

Use dimensions in the query to specify the dimensions to group by

query LeaderboardExample {
  leaderboard(input: {
    ...
    dimensions: [
      {
        columnName: "restaurant_name"
      }
    ]
    ...
  }) {
    headers
    rows
  }
}

Order the results based on a sort direction.

Use sort to specify the sort direction (ASC or DESC)

query LeaderboardExample {
  leaderboard(input: {
    ...
    sort: DESC
    ...
  }) {
    rows
  }
}

Limit the number of rows returned.

Use rowLimit to specify the maximum number of rows to return

query LeaderboardExample {
  leaderboard(input: {
    ...
    rowLimit: 10
    ...
  }) {
    rows
  }
}

Example

Example 1: Simple leaderboard query

Get top 3 restaurants by total taco sales for the current year.

Usage

Arguments

The fields for querying a Metric in leaderboard format.

A Metric’s leaderboard query returns an ordered table of Dimension and Metric values over a given time range.

metric

MetricInput

The Metric to query. You can query a pre-configured Metric by ID or name, or you can query an ad hoc Metric that you define inline.

The ID of a pre-configured Metric.

name

String

The name of a pre-configured Metric.

custom

CustomMetricQueryInput

An ad hoc Custom Metric.

count

CountMetricQueryInput

An ad hoc Count Metric.

sum

SumMetricQueryInput

An ad hoc Sum Metric.

average

AverageMetricQueryInput

An ad hoc Average Metric.

min

MinMetricQueryInput

An ad hoc Min Metric.

max

MaxMetricQueryInput

An ad hoc Max Metric.

countDistinct

CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.

timeRange

TimeRangeInput

The time range for calculating the leaderboard.

The fields required to specify the time range for a time series, counter, or leaderboard Metric query.

If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.

If both relative and absolute time ranges are provided, the relative time range will take precedence.

If a LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.

timestamp

String

The timestamp field to use when querying. Defaults to the timestamp configured on the Data Pool or Metric, if any. Set this to filter on an alternative timestamp field.

relative

RelativeTimeRange

The relative time period.

The Relative time ranges are based on the current date and time.

THIS - The current unit of time. For example, if today is June 8, 2022, and THIS_MONTH is selected, then data for June 2022 would be returned.

PREVIOUS - The previous unit of time. For example, if today is June 8, 2022, and PREVIOUS_MONTH is selected, then data for May 2022 would be returned. It excludes the current unit of time.

NEXT - The next unit of time. For example, if today is June 8, 2022, and NEXT_MONTH is selected, then data for July 2022 would be returned. It excludes the current unit of time.

LAST_N - The last n units of time, including the current one. For example, if today is June 8, 2022 and LAST_N_YEARS with n = 3 is selected, then data for 2020, 2021, and 2022 will be returned. It will include the current time period.

THIS_HOUR: Starts at the zeroth minute of the current hour and continues for 60 minutes.
TODAY: Starts at 12:00:00 AM of the current day and continues for 24 hours.
THIS_WEEK: Starts on Monday, 12:00:00 AM of the current week and continues for seven days.
THIS_MONTH: Starts at 12:00:00 AM on the first day of the current month and continues for the duration of the month.
THIS_QUARTER: Starts at 12:00:00 AM on the first day of the current calendar quarter and continues for the duration of the quarter.
THIS_YEAR: Starts on January 1st, 12:00:00 AM of the current year and continues for the duration of the year.
PREVIOUS_HOUR: Starts at the zeroth minute of the previous hour and continues for 60 minutes.
YESTERDAY: Starts at 12:00:00 AM on the day before the today and continues for 24 hours.
PREVIOUS_WEEK: Starts on Monday, 12:00:00 AM, a week before the current week, and continues for seven days.
PREVIOUS_MONTH: Starts at 12:00:00 AM on the first day of the month before the current month and continues for the duration of the month.
PREVIOUS_QUARTER: Starts at 12:00:00 AM on the first day of the calendar quarter before the current quarter and continues for the duration of the quarter.
PREVIOUS_YEAR: Starts on January 1st, 12:00:00 AM, the year before the current year, and continues for the duration of the year.
NEXT_HOUR: Starts at the zeroth minute of the next hour and continues for 60 minutes.
TOMORROW: ” Starts at 12:00:00 AM, the day after the current day, and continues for 24 hours.
NEXT_WEEK: Starts on Monday, 12:00:00 AM, the week after the current week, and continues for the duration of the week.
NEXT_MONTH: Starts at 12:00:00 AM on the first day of the next month and continues for the duration of the month.
NEXT_QUARTER: Starts at 12:00:00 AM on the first day of the next calendar quarter and continues for the duration of the quarter.
NEXT_YEAR: Starts on January 1st, 12:00:00 AM of the next year and continues for the duration of the year.
LAST_N_MINUTES: Starts at the zeroth second n - 1 minute(s) before the current minute and continues through the current minute. It includes this minute.
LAST_N_HOURS: Starts at the zeroth minute of the n - 1 hour(s) before the current hour, and continues through the current hour. It includes this hour.
LAST_N_DAYS: Starts at 12:00:00 AM, n - 1 day(s) before the current day, and continues through the current day. It includes today.
LAST_N_WEEKS: Starts on Monday, 12:00:00 AM, n - 1 week(s) before the current week, and continues through the current week. It includes this week.
LAST_N_MONTHS: Starts at 12:00:00 AM on the first day of the month, n - 1 month(s) before the current month, and continues through the current month. It includes this month.
LAST_N_QUARTERS: Starts at 12:00:00 AM on the first day of the calendar quarter n - 1 quarter(s) before the current quarter and continues through the current quarter. It includes this quarter.
LAST_N_YEARS: Starts on January 1st, 12:00:00 AM of the year n - 1 year(s) before the current year and continues through the current year. It includes this year.
LAST_15_MINUTES
LAST_30_MINUTES
LAST_HOUR
LAST_4_HOURS
LAST_12_HOURS
LAST_24_HOURS
LAST_7_DAYS
LAST_30_DAYS
LAST_90_DAYS
LAST_3_MONTHS
LAST_6_MONTHS
LAST_YEAR
LAST_2_YEARS
LAST_5_YEARS

Int

The number of time units for the LAST_N relative periods.

start

DateTime

The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool.

stop

DateTime

The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool.

timeZone

String

The time zone to use. Dates and times are always returned in UTC, but setting the time zone influences relative time ranges and granularities.

You can set this to “America/Los_Angeles”, “Europe/Berlin”, or any other value in the IANA time zone database. Defaults to “UTC”.

dimensions

[DimensionInput!]

required

One or many Dimensions to group the Metric values by. Typically, Dimensions in a leaderboard are what you want to compare and rank.

sort

Sort

The sort order of the rows. It can be ascending (ASC) or descending (DESC) order. Defaults to descending (DESC) order when not provided.

rowLimit

Int

required

The number of rows to be returned. It can be a number between 1 and 1,000.

filterSql

String

The Query Filters to apply before retrieving the leaderboard data, in the form of SQL. If no Query Filters are provided, all data is included.

metricId

deprecated

The ID of the Metric to query.

Required if metricName is not specified.

deprecated: Use metric

metricName

String

deprecated

The name of the Metric to query.

Required if metricId is not specified.

deprecated: Use metric

filters

[FilterInput!]

deprecated

The Query Filters to apply before retrieving the leaderboard data. If no Query Filters are provided, all data is included.

deprecated: Use filterSql instead

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column

String

required

The name of the column to filter on.

operator

FilterOperator

required

The operation to perform when comparing the column and filter values.

value

String

The value to compare the column to.

and

[FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

[FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Response

The leaderboard response object. It contains an array of headers and a table (array of rows) with the selected Dimensions and corresponding Metric values for the given time range and Query Filters.

headers

[String!]

required

The table headers. It contains the Dimension and Metric names.

rows

[[String]!]

required

An ordered array of rows. Each row contains the Dimension values and the corresponding Metric value. A Dimension value can be empty. A Metric value will never be empty.

query

QueryInfo

required

The Query statistics and metadata.

The Query Info object. It contains metadata and statistics about a Query performed.

required

The Query’s unique identifier.

createdAt

DateTime

required

The date and time in UTC when the Query was created.

createdBy

String

required

The unique identifier of the actor that performed the Query.

modifiedAt

DateTime

required

The date and time in UTC when the Query was last modified.

modifiedBy

String

required

The unique identifier of the actor that modified the Query.

bytesProcessed

String

required

The bytes processed by the Query.

durationInMilliseconds

Int

required

The duration of the Query in milliseconds.

recordsProcessed

String

required

The number of records processed by the Query.

resultingBytes

Int

required

The bytes returned by the Query.

resultingRecords

Int

required

The number of records returned by the Query.

propeller

Propeller

The Propeller used for this query.

status

QueryStatus

required

The Query status.

type

QueryType

required

The Query type.

subtype

QuerySubtype

The Query subtype.

sql

String

required

The SQL the query executed.

Embeddable UI components

Leaderboard component

A React component for rendering leaderboard data.

useLeaderboard

A React Hook for fetching ranked data from the Leaderboard API.

Get Started

APIs

Metrics

Guides

Use cases

Leaderboard visualization

Aggregated tables

Features

Example

Example 1: Simple leaderboard query

Usage

Arguments

Response

Embeddable UI components

Leaderboard component

useLeaderboard

Get Started

APIs

Metrics

Guides

​Use cases

Leaderboard visualization

Aggregated tables

​Features

​Example

​Example 1: Simple leaderboard query

​Usage

​Arguments

​Response

​Embeddable UI components

Leaderboard component

useLeaderboard

Use cases

Features

Example

Example 1: Simple leaderboard query

Usage

Arguments

Response

Embeddable UI components