Questions tagged [documentation]
Question pertaining to the documentation provided with the API.
147 questions
3
votes
1
answer
225
views
Getting Question data using stack.PHP fails after a certain number of requests
I am trying to build an RSS feed that includes any/all questions that I have answered, and been accepted as the correct answer.
I am running into an issue where I'm sending too many requests and ...
- 163
3
votes
1
answer
77
views
Events: field request
The "Event" object doesn't have an easy way for getting at the object relating to the event. There's a link field, but I don't fancy having to parse the information out of that (although I could).
...
- 5,264
3
votes
2
answers
364
views
What am I allowed/not permitted to do with the API?
I have a site that will offer technical help and assistance for a certain niche of computer users. I can either host my own forums, or tie in with stack... but I want to be able to make money off it ...
- 303
3
votes
2
answers
102
views
Inconsistency in the handling of multiple IDs with a duplicate
There appears to be some inconsistency in the way multiple ids are being handled, especially when a duplicate exists.
Duplicate ID is significant
For example, when requesting a timeline of multiple ...
- 133
3
votes
1
answer
79
views
link in post_id in /me/notifications/unread is wrong
I have run /me/notifications/unread. The response contains post_id and there is a link to it.
This link is wrong. The post is on Stack Apps but the link directs to Stack Overflow:
I have ...
- 834
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
3
votes
1
answer
252
views
API documentation console unsuccessfully tries to load MiniProfiler results
All of the documentation pages (example) with the test console currently attempt to load MiniProfiler result data, which fails with a 404:
POST https://api.stackexchange.com/mini-profiler-resources/...
- 4,686
3
votes
1
answer
263
views
Unable to post a comment using the interactive API documentation
I'm trying to to integrate the Stack Exchange API in my application. I'm trying the authentication but when I got the token and used it it gave a write_access issue. That issue was resolved when I ...
- 133
3
votes
1
answer
97
views
What happened to the /stats method?
I can't find the /stats method in the new usage documentation.
A quick run of http://api.stackoverflow.com/1.1/stats reveals that the method is still there. However, it is not documented.
- 23.2k
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
3
votes
0
answers
65
views
Incorrect link parameter on the "Complex Queries" documentation page
The "Complex Queries" documentation page has this link:
Of these three posts on Server Fault, the one with the most recent activity
where "the one with the most recent activity" links to
https://...
- 260
3
votes
0
answers
59
views
Always show console on API docs
This script stops you having to click the "show console" button to test an API call.
Install - View Source
- 796
3
votes
1
answer
87
views
Minor typo on help page
On the API Routes help page, this:
/users/{id}/favorites Gets summary information for the questions that have been favorited a set of users.
should probably be:
/users/{id}/favorites Gets ...
2
votes
3
answers
104
views
What is the "inname" parameter to the /tags 2.0 API?
I'm just playing with the new 2.0 API and in /tags there is a field inname that I can't find any description or documentation for.
What does it do? Is it like the old filter parameter on the old API?
...
- 872
2
votes
1
answer
121
views
Clarify read-only vs. write operations for Teams in documentation
The API page about Stack Overflow for Teams 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 ...
- 6,965
2
votes
1
answer
140
views
Maximum length of "about me" in the Stack Exchange API?
What is the Maximum length of "about me" in the Stack Exchange API?
The one from the /me path.
And in general, where are the length limits published? If anywhere?
2
votes
1
answer
68
views
Confusing documentation re vectorized requests limits
The documentation for vectorized requests says this:
Most methods that take ids in the Stack Exchange API will take up to 100 of them in a single go. This allows applications to batch work and ...
- 872
2
votes
2
answers
1k
views
Can we have maximum length of string in API help pages?
For the type "string", I think there is some upper limit of character count.
For example,
post title : 200 characters
post body : 30000 characters
In the help page, currently like this
"body": {
...
- 5,042
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
1
answer
73
views
What does "in practice" mean here?
From /answers/{id}/delete:
In practice, this method will never return an object.
For me, "in practice" means that the method will maybe return an object. But why? That's not good from an application ...
- 265
2
votes
1
answer
87
views
`fromdate` and `todate` parameter in `/me` call
What if we don't give the fromdate and/or todate parameters in a /me call?
Will it give result of user of all times? It's not mentioned explicitly in documentation.
- 834
2
votes
1
answer
195
views
Can you identify a user from the access_token?
I have the access_token after authentication from the user. At this point I don't know with which sites this user has registered. Is it possible to get user information like the display name or ...
- 155
2
votes
1
answer
143
views
Indicate in documentation whether "numbers" can be non-integral
"number" is an very ambiguous term. Integral or non-integral?
For developers in more dynamically-typed languages like JavaScript, this is not an issue; but when using more statically-typed languages ...
- 12.1k
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
1
answer
84
views
No token field in the docs test page for /me/reputation-history
There is no form field for an access token at:
https://api.stackexchange.com/docs/me-reputation-history
https://api.stackexchange.com/docs/me-full-reputation-history
After attempting to Run the API ...
- 123