Skip to content
quartzjer edited this page Jul 25, 2011 · 2 revisions

example from twitter

http://localhost:8042/Me/twitter/state
{
    "status": "done syncing home_timeline",
    "updated": 1311382642895,
    "statusLast": 1311382616011,
    "syncing": 1,
    "syncingLast": 1311382616011,
    "home_timeline": 1879,
    "home_timelineLast": 1311382551407,
    "ready": 1,
    "readyLast": 1311382642895,
    "friends": 4,
    "friendsLast": 1311263333390,
    "user_timeline": 77,
    "user_timelineLast": 1311266596284,
    "mentions": 89,
    "mentionsLast": 1311263332832,
    "followers": 151,
    "followersLast": 1311263334523
}

State call is an experiment to give more insight into any services current state, including syncing activities and counts of it's various data types. There are a couple of high-level standard fields:

  • "status" - human-readable current status
  • "updated" - machine-readable timestamp since any data had changed
  • "ready" - machine readable >0 means it's usable, <= 0 means it's not auth'd/setup
  • "syncing" - machine readable >0 indicates that it's actively syncing, <= 0 is idle

The rest of the fields are per-service defined, but are following a general pattern of being named the same as the data type, providing a count and *Last of timestamp when it was updated.

Clone this wiki locally