Skip to main content

LeaderboardResponse

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.

fields

  • headers non-null array of String

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

  • rows non-null array of String

    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 non-null QueryInfo

    The Query statistics and metadata.

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

    • query.id non-null ID

      The Query's unique identifier.

    • query.createdAt non-null DateTime

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

    • query.createdBy non-null String

      The unique identifier of the actor that performed the Query.

    • query.modifiedAt non-null DateTime

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

    • query.modifiedBy non-null String

      The unique identifier of the actor that modified the Query.

    • query.bytesProcessed non-null String

      The bytes processed by the Query.

    • query.durationInMilliseconds non-null Int

      The duration of the Query in milliseconds.

    • query.recordsProcessed non-null String

      The number of records processed by the Query.

    • query.resultingBytes non-null Int

      The bytes returned by the Query.

    • query.resultingRecords non-null Int

      The number of records returned by the Query.

    • query.booster nullable Booster

      If the Query was boosted, the Booster that was used.

    • query.propeller nullable Propeller

      The Propeller used for this query.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • query.status non-null QueryStatus

      The Query status.

      The Query status.

      • COMPLETED

        The Query was completed succesfully.

      • ERROR

        The Query experienced an error.

      • TIMED_OUT

        The Query timed out.

    • query.type non-null QueryType

      The Query type.

      The Query type.

      • METRIC

        Indicates a Metric Query.

      • STATS

        Indicates a Dimension Stats Query.

    • query.subtype nullable QuerySubtype

      The Query subtype.

      The Query subtype.

      • COUNTER

        Indicates a Metric counter Query.

      • TIME_SERIES

        Indicates a Metric time series Query.

      • LEADERBOARD

        Indicates a Metric leaderboard Query.