# app.fitsky.goal

> Published by [thatsit.dev](https://lexicon.garden/identity/did:plc:tr7zlhacx3fete5s7cx5tyjd)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tr7zlhacx3fete5s7cx5tyjd/app.fitsky.goal)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tr7zlhacx3fete5s7cx5tyjd/app.fitsky.goal/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tr7zlhacx3fete5s7cx5tyjd/app.fitsky.goal/examples)

## Definitions

### `app.fitsky.goal`

**Type**: `record`

A fitness goal to track progress against

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `metric` | `string` | Yes |  |
| `period` | `string` | Yes |  |
| `endDate` | `string` (datetime) | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `startDate` | `string` (datetime) | Yes |  |
| `targetValue` | `integer` | Yes | Target value in base units (meters for distance, seconds for duration, seconds-per-km for pace, count for workouts) |

## Raw Schema

```json
{
  "id": "app.fitsky.goal",
  "defs": {
    "main": {
      "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"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
