List teams statistics

GET 
/api/v2/teams/stats

Get the statistics of all teams, or for a specific team by using team ID, over a number of epochs. If a team does not have at least the number of epochs' worth of data, it is ignored.

Request

Query Parameters

teamId string

Restrict team statistics to those with the given team ID.

aggregationEpochs uint64

Defines the number of past epochs to aggregate data from. By default, it takes the last 10 epochs.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

statistics object

Page of teams' statistics data and corresponding page information.

edges object[]

Page of team data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Team's statistics data.

gamesPlayed string[]

List of games played over the requested epoch period.

quantumRewards object[]

List of rewards over the requested epoch period, expressed in quantum value for each epoch.

Array [

epoch uint64

Epoch for which this information is valid.

totalQuantumRewards string

Total rewards accumulated over the epoch period, expressed in quantum value.

]

quantumVolumes object[]

List of volumes over the requested epoch period, expressed in quantum value for each epoch.

Array [

epoch uint64

Epoch for which this information is valid.

totalQuantumVolumes string

Total volumes accumulated over the epoch period, expressed in quantum value.

]

teamId string

Team ID the statistics are related to.

totalGamesPlayed uint64

Total of games played.

totalQuantumRewards string

Total of rewards accumulated over the requested epoch period, expressed in quantum value.

totalQuantumVolume string

Total of volume accumulated over the requested epoch period, expressed in quantum value.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "statistics": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "gamesPlayed": [
            "string"
          ],
          "quantumRewards": [
            {
              "epoch": "string",
              "totalQuantumRewards": "string"
            }
          ],
          "quantumVolumes": [
            {
              "epoch": "string",
              "totalQuantumVolumes": "string"
            }
          ],
          "teamId": "string",
          "totalGamesPlayed": "string",
          "totalQuantumRewards": "string",
          "totalQuantumVolume": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...