Get Goal
beeminder.get_goal
ActionBusiness appsconnection required
Calls the Beeminder API with the connection's credentials.
Read one goal's settings, its current value and when it next derails.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Beeminder
- Secret shape
- the personal auth token, or {"auth_token": "…"} / {"access_token": "…"}
- Config it needs
- username
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
goal The goal's slug — the last segment of its Beeminder URL, e.g. 'weight'. | string | Yes | — | — | weight |
include_datapoints Include the goal's datapoints in the response. | boolean | No | false | — | — |
emaciated Strip the bulky road, roadall and fullroad arrays from the goal. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"emaciated": false,
"goal": "weight",
"include_datapoints": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
slug The goal's identifier, the last segment of its URL. | string | — |
title The human-readable name of the goal. | string | — |
goal_type Goal flavour: hustler, biker, fatloser, gainer, inboxer… | string | — |
goaldate Unix time of the goal date; null when the rate is set. | number | — |
goalval The target value; null when the rate is set. | number | — |
rate The required rate in runits; null when a goal date is set. | number | — |
runits Units the rate is expressed in: y, m, w, d or h. | string | — |
losedate Unix time at which the goal derails if nothing is entered. | number | — |
safebuf How many days of safety buffer the goal currently has. | number | — |
delta How far the goal's current value is from the bright red line. | number | — |
curval The goal's most recent value. | number | — |
curday Unix time of the goal's most recent day with data. | number | — |
pledge Amount in US dollars currently at risk on this goal. | number | — |
updated_at Unix time the goal was last updated. | number | — |
queued True when the goal's graph is waiting to be regenerated. | boolean | — |
graph_url URL of the goal's PNG graph. | string | — |
thumb_url URL of the goal's thumbnail graph. | string | — |
svg_url URL of the goal's SVG graph. | string | — |
autodata The autodata source feeding the goal, or null for manual. | string | — |
won True when the goal has been completed. | boolean | — |
lost True when the goal has derailed and is off track. | boolean | — |
frozen True when the goal is frozen and accepts no new data. | boolean | — |
{
"autodata": "",
"curday": 0,
"curval": 0,
"delta": 0,
"frozen": false,
"goal_type": "",
"goaldate": 0,
"goalval": 0,
"graph_url": "",
"losedate": 0,
"lost": false,
"pledge": 0,
"queued": false,
"rate": 0,
"runits": "",
"safebuf": 0,
"slug": "",
"svg_url": "",
"thumb_url": "",
"title": "",
"updated_at": 0,
"won": false
}See Get Goal run in a workflow.
In a technical demo we add the Beeminder connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.