API Reference

Fetch data about the institution

Institution

The institution entry point is the primary top-level object through which all data is accessed. Other top-level entry points are aliases for fields on the institution.

📘

Institution associations

All of the institution's associations can be accessed via their main-level entry point. For example, rather than querying institution.athletes, you can simply query athletes directly.

Below are the available fields accessible via the Institution object.

athletes(emails: [String], uuids: [String]) => [Athlete]

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

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(uuids: [String]) => [Team]

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

uuid => String

The uuid field returns the UUID generated by FYTT for the object.

Sample Query

Example:

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

Response:

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