app.fitsky.goal Documentation (EN)

main record

A fitness goal to track progress against

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

endDate string datetime Optional

An RFC 3339 formatted timestamp.

metric string Required

No description available.

maxLength: 64 bytes

Known values: distance, workouts, duration, pace

period string Required

No description available.

maxLength: 64 bytes

Known values: weekly, monthly, yearly

startDate string datetime Required

An RFC 3339 formatted timestamp.

targetValue integer Required

Target value in base units (meters for distance, seconds for duration, seconds-per-km for pace, count for workouts)

minimum: 0

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "metric",
      "targetValue",
      "period",
      "startDate",
      "createdAt"
    ],
    "properties": {
      "metric": {
        "type": "string",
        "maxLength": 64,
        "knownValues": [
          "distance",
          "workouts",
          "duration",
          "pace"
        ]
      },
      "period": {
        "type": "string",
        "maxLength": 64,
        "knownValues": [
          "weekly",
          "monthly",
          "yearly"
        ]
      },
      "endDate": {
        "type": "string",
        "format": "datetime"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "startDate": {
        "type": "string",
        "format": "datetime"
      },
      "targetValue": {
        "type": "integer",
        "minimum": 0,
        "description": "Target value in base units (meters for distance, seconds for duration, seconds-per-km for pace, count for workouts)"
      }
    }
  },
  "description": "A fitness goal to track progress against"
}