Resource Brain Dump

This is a list of example urls into the API and what the represent.

company lists

• /companies

sorts

• /companies?sort=recently_active
• /companies?sort=recently_created
• /companies?sort=alpha

paging

• /companies?page=3&limit=10

searching

• /companies?query=Moo

People lists

• /people
• /people?page=3&limit=10

filters

not valid outside of a company's scope

• /companies/satisfaction/people?filter=contributors
• /companies/satisfaction/people?role=employee
• /companies/satisfaction/people?role=company_rep
• /companies/satisfaction/people?role=company_admin

Product Lists

• /products
• /products?page=3&limit=10

sorts

• /products?sort=recently_created
• /products?sort=alpha

search, only available in global scope

• /products?query=macbook

Tag lists

• /tags
• /tags?page=3&limit=10

Topic Lists

• /topics

sorts

Search methods aren't allowed to specify a sort, it always defaults to match quality

• /topics?sort=recently_created
• /topics?sort=recently_active
• /topics?sort=most_flagged
• /topics?sort=unanswered #=> also filters the list

paging

• /topics?page=3&limit=10 # => shows page if the topics list were broken into 10 topics per page.

filters

• /topics?style=problem # => only show problems
• /topics?filter=flagged # => only show topics that have been flagged atleast once. can't be used with the search results

searches

• /topics?query=foo

Reply lists

replies do not exits at the global level, they are always nested under topics

• /topics/why_doesnt_my_brain_work/replies
• /topics/why_doesnt_my_brain_work/replies?page=1&limit=10

sorts

• /topics/why_doesnt_my_brain_work/replies?sort=most_useful
• /topics/why_doesnt_my_brain_work/replies?sort=recently_created

filters

• /topics/why_doesnt_my_brain_work/replies?filter=best
• /topics/why_doesnt_my_brain_work/replies?filter=star_promoted

• /topics/why_doesnt_my_brain_work/replies?filter=company_promoted

• /topics/why_doesnt_my_brain_work/replies?user=13 #replies created by user with id 13

Nestings

All of the various resources above are exposed through various nestings to expose useful relationships and attributes. These nesting accept the same parameters as the lists above, with a few exceptions