API reference/Goals

Get a revenue goal

Try it

Read a persisted monthly goal in whole dollars. An unset month returns zero.

GET/api/v1/goals/{period}

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

goals:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

periodRequired: string

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "period": "YOUR_VALUE"
}

Input schema

{
  "type": "object",
  "properties": {
    "period": {
      "type": "string",
      "pattern": "^20\\d{2}-(0[1-9]|1[0-2])$"
    }
  },
  "required": [
    "period"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "period": {
      "type": "string"
    },
    "amount": {
      "type": "number"
    }
  },
  "required": [
    "period",
    "amount"
  ],
  "additionalProperties": false
}