API Reference

Fetch institution KPI info

Kpv

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

The Kpv object is the access point for basic information about the KPV. 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 KPV's description, as provided by the coach that created it.

name => String

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

unit => String

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

uuid => String

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

Sample Query

Example:

query {
  kpvs {
    name,
    uuid
  }
}

Response:

{
  "data": {
    "kpvs": [
      {
        "name": "Weight",
        "uuid": "7ceadaa7-b5a5-4e51-8c74-655af08490ea"
      },
      {
        "name": "Height",
        "uuid": "2f5b2fdf-68ac-45eb-8f0b-7ad1fec41a4e"
      },
      {
        "name": "Sleep",
        "uuid": "cdf9d49e-2335-4b34-8ba1-7c94a2b191b5"
      },
      {
        "name": "Fatigue",
        "uuid": "3c2dafb4-160d-4b67-be63-d2d6915310ec"
      },
      {
        "name": "Soreness",
        "uuid": "abc53a7c-91e7-4027-9a49-7705b08b24d6"
      }
    ]
  }
}