Questions tagged [documentation]
Question pertaining to the documentation provided with the API.
147 questions
2
votes
1
answer
215
views
Documentation describing fields for api stack exchange
When I looked through the StackExchange documentation, I didn't find any documentation describing the fields. I have to study the request and response for a long time in order to understand why this ...
2
votes
0
answers
126
views
Uncaught channelUrl must be under the current domain
I'm developing a Stack Chrome extension that will make use of the API. I'm following the instructions on the API docs here.
My OAuth and host websites are set to stackexchange.com in my Stack Apps ...
- 171
2
votes
1
answer
88
views
Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, incl. differences between them?
Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, including differences between them?
Basically, I'm looking for onboarding documentation ...
2
votes
0
answers
98
views
Update Teams API documentation to reflect dependency on tier
The documentation says (emphasis mine):
Starting with the release of Stack Overflow For Teams, the Stack Exchange API exposes read-only access to data stored in private Teams.
This is slightly ...
- 6,965
1
vote
1
answer
101
views
Wrong sorting parameter in documentation for question/{ids}/answers
It looks like that in the question/{ids}/answers documentation, there is a mistake:
votes – score
Shouldn't this be
votes – votes
- 111
2
votes
0
answers
72
views
List /network-activity methods under Network Methods in the documentation
The API methods /users/{id}/network-activity and /me/network-activity, both return a summary of a user's activity across the Stack Exchange network and do not take a site parameter.
They are ...
- 6,965
2
votes
1
answer
122
views
"Javascript" typo on documentation pages
On page Usage of /sites, it should be JavaScript, not Javascript, in the right sidebar:
This obviously also applies to (most/all) API documentation pages, since they share the sidebar.
- 373
2
votes
0
answers
50
views
.wrapper not sorted correctly in filter edit popup
When editing the filter, e.g. on this API documentation page, all types are sorted alphabetically except for .wrapper which is always shown below answer, instead of above it (or at the end):
Obviously,...
- 6,965
2
votes
1
answer
108
views
What are the top level question & answer localized flag_option titles?
For the SE API, the endpoints dealing with flags (e.g. /questions/{id}/flags/options) return the flag_option type. However, the option_id values are explicitly stated as being unstable, but it's ...
- 1,676
6
votes
0
answers
84
views
Docs say the API returns a user's age, but it doesn't (anymore)
The doc page says that the user object returns an age property (for those users that specified an age).
But the API no longer does. (Plus spot checks of users that had age in ...
- 13k
4
votes
1
answer
449
views
My filter is not returning any results. How to create a minimal filter?
I'm having trouble getting the SO API Filters to cooperate. I've gone over the documentation as well as similar questions like this and this.
I'll use this call as an example since it successfully ...
- 256
3
votes
0
answers
53
views
"users" link lands on the answer page
On the /users/moderators documentation site, the following link is wrong:
This method returns a list of users.
The users link mistakenly points to the answers object instead of to the users object.
- 265
4
votes
1
answer
214
views
“Try It” URL has wrong URI
On API doc pages, the “link” link at the top-right of the “Try It” sections presents a URL with the wrong domain name:
For example, on docs/similar, the URL displayed will be:
https://api....
- 165
2
votes
0
answers
25
views
'search_excerpt' type issues
On the search_excerpt page:
community_owned_date should be marked as may be absent
locked_date should be marked as may be absent
search/excerpts should be listed in the Methods That Return This Type ...
- 273
2
votes
0
answers
38
views
New line missing between 'notice' and 'related_site' member types
At the bottom of http://api.stackexchange.com/docs?tab=type#docs under the Member Types section, notice and related_site are on the same line. A <br> is missing between the items.
- 273
2
votes
1
answer
95
views
Notice field on questions may be absent?
The notice type, that is a field of a question, appears to be optional, yet it is not marked as "may be absent"?
For example, when I request questions with a filter that has the notice field checked, ...
- 121
5
votes
1
answer
151
views
Typos on api.stackexchange.com/docs/js-lib
Under the Authentication section on https://api.stackexchange.com/docs/js-lib, there are a few typos (emphasis mine):
scope (optional) – an array of scopes to request during authentication, valid ...
- 4,405
1
vote
1
answer
116
views
Why is the `site` parameter required in `/me` call?
I want to query information about the logged-in user using me, and this site parameter is creating some small problems.
I am developing a visual studio extension where upon logging in a user will get ...
- 834
3
votes
1
answer
104
views
The /tags query is not giving me the correct results between two dates?
I'm trying to get the yearly total number of questions that have the tag browserify.
I can see that there are questions tagged from this year like this one and that one.
The site reports that there ...
- 133
3
votes
1
answer
211
views
Difference between `/inbox/unread` & `/me/inbox/unread`
I ran /inbox/unread & /me/inbox/unread.
What is the difference between the two? Also, the site parameter which we give in call to /me/inbox/unread is not required as inbox_item refers to global ...
- 834
2
votes
1
answer
81
views
Where is "items" & "badge_counts" documentation?
Where is the items & badge_counts documentation?
This is returned as JSON. I am using the /me/associated query function.
- 834
5
votes
1
answer
97
views
Which reputation events are private?
I've been reading the API documentation on retrieving a user's reputation history (docs/types/reputation-history)
and Stack Overflow's description of how reputation is calculated.
But, I can't find ...
- 153
3
votes
1
answer
138
views
top-answerers / top-askers documentation bug: number of results returned incorrect
The top-answerers-on-tags and top-askers-on-tags documentation claim:
Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days.
and
Returns the top 30 askers ...
- 931
0
votes
1
answer
90
views
Are the "body", "comments" and "answers" parameters supported in the API version 2.x?
Earlier with version 1.x, the parameters: body, comments and answers etc. were available. But these don't seem to be supported with API version 2.x.
Are these parameters not supported in new API? Are ...
- 325
2
votes
0
answers
81
views
Version used by StackExchange API if version is not specified in api calls
I have used some StackExchange API calls in my chrome extension - StackEye. With the release of API 2.0, I want to update the api calls so I wanted to know
New things available in 2.0+ which were not ...
- 933