goalsGet goal progress history

Get goal progress history

curl -X GET "https://api.403fin.io/v1/goals/123e4567-e89b-12d3-a456-426614174000/history?start_date=2024-12-25&end_date=2024-12-25&resolution=daily" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "goal_id": "123e4567-e89b-12d3-a456-426614174000",
      "snapshot_date": "2024-12-25",
      "current_amount": "example_string",
      "target_amount": "example_string",
      "progress_pct": "example_string"
    }
  ],
  "pagination": {
    "next_cursor": "example_string",
    "has_more": true
  },
  "redacted_fields": [
    "example_string"
  ],
  "filtered": true
}
GET
/v1/goals/{id}/history
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key (header: X-API-Key)
X-API-Keystring
Required

An opaque ff_ credential presented in the X-API-Key header.

An opaque ff_ credential presented in the X-API-Key header.
path
idstring
Required

The resource UUID.

Format: uuid
query
start_datestring
Required

Inclusive start date (YYYY-MM-DD).

Format: date
query
end_datestring

Inclusive end date (YYYY-MM-DD).

Format: date
query
resolutionstring
Options: daily, weekly, monthly
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

header
X-API-Keystring
Required

API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.

Path Parameters

idstring
Required

The resource UUID.

Query Parameters

start_datestring
Required

Inclusive start date (YYYY-MM-DD).

end_datestring

Inclusive end date (YYYY-MM-DD).

resolutionstring
Allowed values:dailyweeklymonthly

Responses

dataarray
Required
paginationstring

Cursor pagination state, present on list endpoints.

redacted_fieldsstring[]

Field ids stripped from the payload by connection scope.

filteredboolean

True when row or aggregate filtering is in effect for this response.