institution.kpis

Fetch institution KPI info

Kpi

The Kpi object within the institution scope is the access point for basic information about the KPI.

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:

GraphQL

query {
  institution {
    kpis {
      name,
      uuid
    }
  }
}

Response:

JSON

{
  "data": {
    "institution": {
      "kpis": [
        {
          "name": "Shoulder Press E1RM",
          "uuid": "206a00a4-579f-4ab9-9227-4a7fc196662b"
        },
        {
          "name": "Back Squat 1RM",
          "uuid": "bc7ec5fe-8508-4c11-bbd1-29be86a1f77e"
        },
        {
          "name": "Bench Press 1RM",
          "uuid": "8ec74779-49ed-431c-a3eb-9271a4f22336"
        }
      ]
    }
  }
}