API Reference

Fetch institution KPI info

Metric

metrics(uuids: [String] ) => [Metric]

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

name => String

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

unit => String

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

uuid => String

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

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" } ] } }