API Data Provider - Online Help

Goals

Query active Beeminder commitment contracts with progress tracking, pledge amounts, deadline dates, graph data, and all configuration settings for user accountability goals.

Columns

Name Type ReadOnly References Description
Slug [KEY] String False

URL identifier for the goal; can change over time, use Id for stable references

Title String False

User-specified display name for the goal as shown in the Beeminder interface

Status String True

Current urgency based on safety buffer: green (3+ days safe), blue (2 days), orange (1 day), red (beemergency)

The allowed values are green, blue, orange, red.

CreatedAt Datetime True

Unix timestamp when the bright red line starts and goal tracking began

UpdatedAt Datetime True

Unix timestamp of last modification to goal settings or road configuration

GoalVal Double False

Target value to reach by goaldate; null if calculated from rate and goaldate (exactly one of goalval/rate/goaldate is null)

Rate Double False

Slope of the bright red line representing required progress rate; null if calculated from goalval and goaldate

GoalDate Datetime False

Unix timestamp when goal reaches goalval; null if calculated from rate and goalval (commitment contract requires exactly 2 of 3 parameters)

SvgUrl String True

URL to vector graphics (SVG) version of the goal progress graph for high-quality displays

GraphUrl String True

URL to PNG raster image of the goal progress graph

ThumbUrl String True

URL to small thumbnail preview image of the goal graph for quick visual reference

GoalType String False

Goal behavior type: hustler (do more), biker (odometer), fatloser (lose weight), gainer (gain weight), inboxer (inbox zero), drinker (do less), or custom

Autodata String True

Name of automatic data integration source (e.g., 'fitbit', 'github', 'rescuetime'); null for manually tracked goals

HealthkitMetric String True

Apple HealthKit metric name being auto-tracked (e.g., 'steps', 'exercise_time') when iOS integration is enabled

AutodataConfig String True

JSON object containing configuration settings for the automatic data integration

LoseDate Datetime True

Unix timestamp when the goal will derail if no progress is made; the beemergency deadline

UrgencyKey String True

Composite sorting key for ordering goals by urgency combining safety buffer days, goal importance, and other factors for dashboard prioritization

Deadline Integer True

Seconds after midnight (00:00) when the Beeminder day ends and datapoints are due; defaults to 6am (21600 seconds)

Leadtime Integer True

Seconds before the deadline when reminders start being sent; use 0 for reminders at deadline, or higher values like 86400 for 24-hour advance notice

Alertstart Integer True

Seconds before the deadline when alert notifications begin; typically less than leadtime for escalating urgency

IsUseDefaults Boolean True

True if this goal uses the user's account-level default settings for deadline and reminder times; false for custom per-goal settings

Id String True

Permanent unique identifier (hex string) for the goal; preferred over slug which can change

IsEphem Boolean True

True if this is an ephemeral test goal that will be automatically deleted after a period; used for API testing and experimentation

IsQueued Boolean True

True if road dial changes are queued and waiting to take effect after the one-week akrasia horizon delay

Panic Integer True

Seconds before deadline when panic mode activates; typically 86400 (24 hours) to trigger emergency notifications and increased urgency display

Burner String True

Goal priority level: 'frontburner' for active focus goals, 'backburner' for maintenance mode with minimal effort

The allowed values are frontburner, backburner.

Yaw Integer True

Which side of bright red line is good: +1 (above line is good/yay), -1 (below line is good); combined with dir determines goal type

Delta Double True

Current distance from the bright red line in goal units; positive means safe above the line, negative means derailed below the line

Runits String True

Rate units for displaying slope: 'y'(yearly), 'm'(monthly), 'w'(weekly), 'd'(daily), or 'h'(hourly); combined with gunits to form readable rate like '5 pages per day'

Limsum String True

Human-readable summary of maximum daily rate limit for do-less goals (e.g., 'at most 5 cigarettes per day')

IsFrozen Boolean True

True if goal is frozen (stopped/paused with bright red line flattened); no derailment risk but also no progress required until restarted

IsLost Boolean True

True if goal has derailed (crossed to wrong side of bright red line); triggers pledge charge and commitment contract consequences

IsWon Boolean True

True if goal was successfully completed by reaching the goalval at or before goaldate; archived victorious goal

Contract String True

Commitment contract object containing pledge amounts and stepdown schedule for the accountability system

ContractAmount Decimal True

Current pledge amount in USD at stake; charged to payment method on next derailment

ContractStepdownAt Datetime True

Unix timestamp when pledge will automatically decrease to previous level after sustained success without derailments

ContractPendingAmount Decimal True

New pledge amount waiting to take effect after the akrasia horizon (7-day anti-backsliding delay); null if no change pending

ContractPendingAt Datetime True

Unix timestamp when the pending pledge change will become the active contract amount; null if no change queued

DeltaText String True

Human-readable description of current position relative to bright red line with units (e.g., '2.5 pushups to the good', '1.2 pounds over the line')

Safebuf Integer True

Number of safe days of buffer; 0 means beemergency (must report progress today to avoid derailment); negative means already derailed

Safebump Double True

Amount of progress needed today (in goal units) to gain one additional day of safety buffer; the incremental cost of extra safety

Safesum String True

Human-readable safety buffer summary combining safebuf with context (e.g., 'safe for 3 more days', 'due in 18 hours')

Autoratchet String True

Maximum safety buffer days allowed; road automatically ratchets closer when exceeded to prevent excessive cushion and maintain commitment pressure

IsCoasting Boolean True

True if goal has a flat bright red line (rate=0); maintaining current level without required increase or decrease

Limsumdate String True

Human-readable summary showing absolute calendar date when rate-limited goals become unrestricted (e.g., 'at most 5/day til Dec 31')

Limsumdays String True

Human-readable summary showing relative days until rate limit expires (e.g., 'at most 5/day for 12 more days')

Baremin String True

Bare minimum progress required today to avoid derailment; the absolute least you must do before deadline to stay on the right side of red line

Baremintotal String True

Total cumulative value required by end of day to stay on track; different from baremin for cumulative (kyoom) goals

Roadstatuscolor String True

Color-coded urgency indicator: green (3+ safe days), blue (2 days), orange (1 day), red (beemergency - due today)

The allowed values are green, blue, orange, red.

Lasttouch Datetime True

ISO 8601 timestamp of last interaction; updated when goal settings changed or datapoints added; used for sorting recently active goals

IsIntegery Boolean True

True if goal accepts only integer values with no decimal places (e.g., counting discrete items like pages or workouts)

Fineprint String True

User-specified commitment contract description defining the rules, terms, and conditions for this goal; displayed with pledge information

IsTodayta Boolean True

True if task is available to complete today for IFTTT/Zapier 'Do Today' trigger; helps external automation tools identify actionable goals

IsTimey Boolean True

True if goal tracks time duration; datapoint values interpreted as seconds and displayed in HH:MM:SS format

Gunits String False

Goal units name for measurements (e.g., 'hours', 'pages', 'pushups', 'pounds'); displayed on graph y-axis and in progress descriptions

IsWeekendsOff Boolean True

True if bright red line flattens on Saturdays and Sundays; no progress required on weekends but weekdays maintain the specified rate

Yaxis String False

Label for vertical axis on the goal graph; typically combines curval description with gunits (e.g., 'Total pages read')

Maxflux Double True

Maximum allowed daily fluctuation for noisy data goals like weight; Beeminder smooths/averages values within this range to find the true trend

Tmin Date False

Unix timestamp of earliest datapoint; marks beginning of actual data history (may be after initday if no data entered initially)

Tmax Date False

Unix timestamp of most recent datapoint; marks the current edge of recorded data

Initday Datetime True

Unix timestamp when bright red line starts; the origin point (t=0) where the road begins, equals tmin for goals with initial data

Initval Double False

Starting y-axis value where bright red line begins; the baseline from which progress is measured

Curday Datetime True

Unix timestamp of current Beeminder day; the 'today' for this goal considering the custom deadline time

Curval Double True

Current cumulative value as of most recent datapoint; total progress achieved so far for kyoom goals, or latest value for non-kyoom

Currate Double True

Current rate of progress calculated from recent data trend; may differ from goal rate, showing actual performance vs. commitment

Lastday Datetime True

Unix timestamp of last day with an explicitly entered datapoint; different from tmax which includes auto-generated or inferred points

Dir Integer True

Bright red line direction: +1 for upward slope (increase over time), -1 for downward slope (decrease over time); combined with yaw determines goal type semantics

IsKyoom Boolean True

True if goal uses cumulative tracking; datapoints are summed together (like total pages read); false means latest value only (like current weight)

Odom Double True

Odometer reading for distance/count goals; cumulative total that continues counting even when datapoint resets to zero (treats zeros as accidental resets, not true zero)

IsNoisy Boolean True

True if data has high variance requiring smoothing, typically weight-tracking goals where daily fluctuations don't reflect true trend, triggers moving average calculations

Aggday String True

Aggregation method for multiple datapoints on same day: 'sum' (add all), 'last' (most recent), 'max' (highest), 'min' (lowest), 'mean' (average)

The allowed values are sum, last, max, min, mean.

IsPlotall Boolean True

True to plot all individual datapoints on graph; false to plot only daily aggregated values; useful for visualizing intra-day patterns

IsSteppy Boolean True

True for step function graph display with flat horizontal segments between datapoints; false for linear interpolation connecting points with diagonal lines

IsRosy Boolean True

True for optimistic aggregation taking the best datapoint of each day (furthest in good direction); false uses aggday setting; helps visualize best-case performance

IsMovingav Boolean True

True to display exponentially-weighted moving average line on graph for smoothing noisy data; helps identify underlying trend through daily variance

IsAura Boolean True

True to show aura visualization with colored background regions on graph indicating safety zones; visual urgency indicator with green/blue/orange/red bands

Numpts Integer True

Total count of datapoints submitted for this goal; includes all entries even if later deleted or modified

Road String True

Array of [time, value, rate] tuples defining bright red line segments; the core commitment schedule

Roadall String False

Complete road array including initial row [initday, initval, null] and final row; adds endpoints to road

Fullroad String True

Roadall with all nulls filled in; computed values for goaldate, goalval, and rate in every segment

IsSecret Boolean False

True if goal is private requiring login to view; hidden from public gallery; false means publicly visible on Beeminder.com

Pledge Decimal True

Current stake amount in USD charged to payment method on next derailment; escalates exponentially after each failure

PledgeCap Decimal True

Maximum pledge cap in USD; prevents pledge from escalating beyond this amount regardless of derailment count

Mathishard String True

Array with all three parameters [goaldate, goalval, rate] filled in for verification; Beeminder computes the third parameter from the given two

IsDatapublic Boolean False

True if datapoints are publicly viewable; false requires login to see data; independent of secret setting which controls goal visibility

Rah Double True

Red line value at the akrasia horizon (7 days ahead); shows where commitment line will be after the anti-backsliding delay period

LastDatapoint String True

Most recent datapoint object with timestamp, value, comment; quick access without fetching all datapoints

CallbackUrl String True

Webhook URL for notifications; Beeminder POSTs to this URL when datapoints added or goal status changes; enables integrations and custom monitoring

Tags String False

Array of user-defined alphanumeric tags for categorizing and filtering goals; used for dashboard organization

RecentData String True

Array of recent datapoints included in goal object; preview of latest progress without separate API call

Dueby String True

Object mapping future dates to required cumulative values; shows upcoming progress milestones and deadlines

Username String False

Beeminder account username; required for API authentication to access user's goals

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
IsDatapointsIncluded Boolean

Set true when querying single goal to include complete datapoints array in response; adds all historical data entries with timestamps and values

IsEmaciated Boolean

Set true to exclude road, roadall, and fullroad arrays from response; significantly reduces payload size for bandwidth-constrained applications

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0