# Missing API documentation: Goal Resource

**URL:** <https://forum.beeminder.com/t/missing-api-documentation-goal-resource/495>\
**Category:** Tech\
**Created:** [February 10, 2015, 8:25pm UTC](https://forum.beeminder.com/t/missing-api-documentation-goal-resource/495 "2015-02-10T20:25:52Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![insti](https://sea1.discourse-cdn.com/flex019/user_avatar/forum.beeminder.com/insti/32/545_2.png) [@insti](https://forum.beeminder.com/u/insti)\
**Post date:** [February 10, 2015, 8:25pm UTC](https://forum.beeminder.com/t/missing-api-documentation-goal-resource/495/1 "2015-02-10T20:25:53Z")

</div>

## Goal Resource

`goaldate` - (number) Timestamp of goal target date  
`goalval` - (number) Value of goal target  
`rate` - (number) How many you need to do per rate unit (see `runits`)

(`goaldate`, `goalval`, `rate`) form a tuple, one of which should be null, however the missing number will be provided in the `mathishard` array.

`updated_at` - (number) Unix timestamp (in seconds) of the last update to this goal

`id` - (hex string) Goal ID  
`callback_url` - (string) Callback URL for the goal  
`description` - (string) User-supplied description of goal (listed in sidebar of graph page as “Goal Statement”)  
`graphsum` - (string) text summary of the graph  
`delta` - (number) distance from the center line of your graph at the end of today  
`lanewidth` - (number) width of the lanes either side of the centerline of the yellow brick road

`deadline` - (number) Seconds by which your goal day boundary differs from midnight. Negative is before midnight, positive is after midnight. (TODO: allowable range)

`ephem` - (deprecated and should be removed)  
`plotall` - Whether to plot all the datapoints, or only the aggday-ed one that counts  
`rah` - Road value at akrasia horizon

---

<div class="post-metadata">

**Author:** ![insti](https://sea1.discourse-cdn.com/flex019/user_avatar/forum.beeminder.com/insti/32/545_2.png) [@insti](https://forum.beeminder.com/u/insti)\
**Post date:** [February 10, 2015, 8:29pm UTC](https://forum.beeminder.com/t/missing-api-documentation-goal-resource/495/2 "2015-02-10T20:29:46Z")

</div>

I found that the [API documentation](https://www.beeminder.com/api) was missing a few things about the goal resource, so I’ve added them above. Hopefully one of the devs can help out with more information and turn it into a wiki post so we can keep it updated.

---

<div class="post-metadata">

**Author:** ![dreev](https://sea1.discourse-cdn.com/flex019/user_avatar/forum.beeminder.com/dreev/32/4311_2.png) [@dreev](https://forum.beeminder.com/u/dreev)\
**Post date:** [February 10, 2015, 10:28pm UTC](https://forum.beeminder.com/t/missing-api-documentation-goal-resource/495/3 "2015-02-10T22:28:57Z")

</div>

Thanks so much, @insti! I’m making it my [mustdo](http://blog.beeminder.com/mustdo "Have I mentioned how brilliant this post is? Thanks again to Alice Harris!") for tomorrow to get the API docs up to speed with these parameters.

---

<div class="post-metadata">

**Author:** ![dreev](https://sea1.discourse-cdn.com/flex019/user_avatar/forum.beeminder.com/dreev/32/4311_2.png) [@dreev](https://forum.beeminder.com/u/dreev)\
**Post date:** [February 12, 2015, 12:19am UTC](https://forum.beeminder.com/t/missing-api-documentation-goal-resource/495/4 "2015-02-12T00:19:22Z")

</div>

And done! [bmndr.com/api](http://beeminder.com/api)  
Thanks again, @insti. Calling this a [UVI](http://messymatters.com/uvi "Have you read our article about 1000 User-Visible Improvements to Beeminder? It's very good if we do say so ourselves.") too:

> <https://twitter.com/beemuvi/status/565666164807045120>

---

<div class="post-metadata">

**Author:** ![insti](https://sea1.discourse-cdn.com/flex019/user_avatar/forum.beeminder.com/insti/32/545_2.png) [@insti](https://forum.beeminder.com/u/insti)\
**Post date:** [February 12, 2015, 8:09am UTC](https://forum.beeminder.com/t/missing-api-documentation-goal-resource/495/5 "2015-02-12T08:09:22Z")

</div>

Great.Thanks!

💖 Beeminder 🐝
