institution

Query data through the institution entry point

Institution

The institution entry point is the top level object through which all data at an institution must be accessed. Below are the available fields nested underneath the Institution object.

athletes(athleteEmails: [String]*) => [Athlete]

The athletes field returns a list of athlete objects with the data points you requested. It accepts an optional athleteEmails argument that allows you to request data about specific athletes by providing an array of emails.

kpis(uuids: [String]*) => [Kpi]

The kpis fields returns a list of KPI objects with the data points you requested. It accepts an optional uuids argument that allows you to request data about specific KPIs by providing an array of UUIDs.

kpvs(uuids: [String]*) => [Kpv]

The kpvs fields returns a list of KPV objects with the data points you requested. It accepts an optional uuids argument that allows you to request data about specific KPVs by providing an array of UUIDs.

name => String

The name fields returns the name of the institution.

teams => [Team]

The teams field returns an array of team objects with the data points you requested.

Sample Query

Example:

GraphQL

query {
  institution {
    name,
    teams {
      name
    }
  }
}

Response:

JSON

{
  "data": {
    "institution": {
      "name": "FYTT",
      "teams": [
        {
          "name": "SVS"
        },
        {
          "name": "Basketball"
        },
        {
          "name": "Football"
        }
      ]
    }
  }
}