API Reference

Fetch institution KPI info

Kpi

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

The Kpi object is the access point for basic information about the KPI. The entry point accepts an optional uuids argument to scope the query by a list of UUIDs.

description => String

The description field returns a text string of the KPI's description, as provided by the coach that created it.

name => String

The name field returns a text string of the KPI's name, as provided by the coach that created it.

unit => String

The unit field returns a text string of the KPI's designated unit of measurement, if applicable.

uuid => String

The uuid field returns a text string of the KPI's UUID that was auto-generated by FYTT. This attribute can be used in queries and mutations to identify a given KPI.

Sample Query

Example:

query {
  kpis(uuids:["f43feed5-106b-4ffc-8889-84e35a576159"]) {
    name,
    uuid
  }
}

Response:

{
  "data": {
    "kpis": [
      {
        "name": "Back Squat 1RM",
        "uuid": "f43feed5-106b-4ffc-8889-84e35a576159"
      }
    ]
  }
}