Stats

Query Stats Data

post/stats

Request

Base URL
https://connect-au.catapultsports.com/api/v6
Auth
HTTP bearer
TypeScript
https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api/docs/stats/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

group_bystring[]

Group by

parametersstring[]

Parameters to include in each row of stats

sortingstring[]

List of parameters to sort by

source'cached_stats' | 'annotation_stats'

Stats source

requested_onlyboolean

Return only the values indicated in parameters input

Example request

{
  "filters": [
    {
      "name": "activity_id",
      "comparison": "=",
      "values": [
        "0224615f-a286-40b3-97f4-7e4ec13e8529",
        1749852000
      ]
    }
  ],
  "group_by": [
    "activity"
  ]
}

Response

List of stats

errorsobject

Details of any errors encountered while calculating parameters, indexed by parameter name

Changes

No recorded changes to this operation across all 2 revisions of this API.