Item Endpoint
The Item endpoint gives you complete access to what words a user is studying, how well they know it, and some key info about the history of an item's study. Use this endpoint if you would like to know:
- What words are being studied.
- How well any given word/part is known.
- What was studied last, or will be studied next.
Examples
Goal: Fetch all writing and tone Items the user has ever created.
Solution: make repeated calls, passing back the cursor string for each subsequent call, leaving all other parameters constant.
# unlike 'next' or 'last', 'changed' includes all Items the user has
# regardless of current state
params = {
'sort': 'changed',
'parts': 'rune,tone',
'bearer_token': token,
'gzip': False
}
items = [] # where we'll be storing the results
while True:
# make repeated calls to fetch everything.
response = client.get('http://beta.skritter.com/api/v0/items', params)
response = json.loads(response.content)
# once there's no cursor, we can stop
if not 'cursor' in response:
break
# gather up the results
items += response['Items']
print 'fetched %d items' % len(items)
# for the next iteration, provide the cursor from the last response
params['cursor'] = response['cursor']
return items
Note: this can be done much faster through Parallel GET queries.
· · · Table of Contents · · ·
Topics
Resource Endpoints
- Cancellations
- Coupons
- Items
- Payments
- ProgressStats
- Reviews
- SRSConfigs
- Subscriptions
- Users
- Vocabs
- VocabLists
- VocabListSections
- VocabUpdates