All Questions
Tagged with api-help or documentation
147 questions
2
votes
0
answers
78
views
Clarification on related tags for a tag returned by API
I was assuming that the related tags API call, returns all the tags that co-occur with the input tag. But a closer look at the API documentation indicate the following:
Returns the tags that are ...
- 121
2
votes
1
answer
39
views
type related_site not listed in 'by type' tab list
The type "related_site" is not listed in the 'by type' tab in documentation.
- 872
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/...
- 18.6k
4
votes
1
answer
69
views
Typo in the docs for /me
The doc says:
Returns the user associated with the passed auth_token.
This method returns a user.
It should say "access_token" instead of "auth_token".
- 18.6k
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 ...
- 18.6k
5
votes
1
answer
211
views
Do the terms "key" and "access_token" refer to the same thing?
I'm trying to get my head around all the limits and throttles but some terminology is confusing me:
If an application does not have an access_token, then the application shares an IP based quota ...
- 18.6k
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 ...
- 18.6k
5
votes
1
answer
52
views
Typo in API filter documentation
When using unsafe filters, the API returns the highest fidelity data is can reasonably access for the given request.
should be
When using unsafe filters, the API returns the highest fidelity data it ...
- 18.6k
1
vote
1
answer
56
views
Minor typo in /tags/{tag}/top-askers/{period}
The discussion for the above method says "Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days." It should be corrected as askers.
CommunityBot
- 1
2
votes
1
answer
85
views
Where can I request an API key in the docs?
Can you mention the possibility of requesting an API key in the docs? It was displayed for the 1.0 API.
CommunityBot
- 1
2
votes
1
answer
42
views
Dead link in documentation
On the docs for question timelines the link for "Question" points to /docs/type/question when it should point to /docs/types/question
- 18.6k
4
votes
1
answer
58
views
Stylistic error on the JavaScript SDK documentation page
There is a small stylistic error on the JavaScript SDK documentation page.
Your application must have the client side OAuth flow enabled, and must not have disabled the desktop application redirect ...
- 18.6k
2
votes
1
answer
71
views
There is a small discrepancy in the docs for users-id-associated
The main doc page, https://api.stackexchange.com/docs, shows /users/{id}/associated while the method page, https://api.stackexchange.com/docs/associated-users, uses /users/{ids}/associated.
It's ...
- 18.6k
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).
...
- 18.6k
1
vote
1
answer
53
views
There is a typo in the authentication documentation
There is a typo on this documentation page.
It says "The explcit OAuth 2.0 flow" but it should say "The explicit OAuth 2.0 flow".
- 18.6k
2
votes
1
answer
63
views
integer and decimal are used to describe fields in return types but not in method parameters
Integer and Decimal designations are useful in creating an accurate model of API methods and types.
These specific 'number' subtypes are used when describing types but the method parameter lists all ...
- 18.6k
1
vote
1
answer
52
views
Documentation of /users/{id}/top-answer-tags conflicts with implementation.
According to the documentation:
/users/{id}/top-answer-tags or /me/top-answer-tags – Get the top 30 tags (by score) a single user has posted answers in.
However in practice, when retrieving data ...
CommunityBot
- 1
0
votes
1
answer
98
views
API console always queries Stack Overflow
On any Stack Exchange site (well, I tried Super User (trilogy), Unix (SE-2.0 launched) and SFF (SE-2.0 beta)), the console (“Show Console” button) in the 1.1 API queries http://api.stackoverflow.com/1....
CommunityBot
- 1
4
votes
2
answers
119
views
Documentation sorted by return type
Right now the documentation is pretty terribly organized. For example, consider the things under the "Users" heading:
/users => returns Users
/users/{ids} => returns Users
/users/{ids}/answers => ...
- 18.6k
3
votes
1
answer
74
views
Documentation has broken link (JSONP)
On Wikipedia, JSONP now has its own article, instead of being part of the JSON article.
The documentation links JSONP to Wikpedia:JSON#JSONP. It should link to Wikipedia:JSONP.
- 23.2k
2
votes
1
answer
85
views
Minor spello/typo on the "Complex Queries" documentation page
The documentation page
Complex Queries
has a minor typo or spello:
The ?filter=total build-in filter is provided for just this purpose.
Should instead be:
The ?filter=total built-in filter is ...
- 18.6k
0
votes
1
answer
70
views
Make API query to only one Stack Exchange site
Is there a way to limit a /search or a /similar query to a specific site or sites?
- 23.2k
3
votes
1
answer
347
views
API Time zone difference problem
I am writing a .NET application with the Stack Exchange API (using the Stacky library) and I am using it to ask the server for some questions that occured in the last hour. However, I and the server ...
- 231
1
vote
2
answers
88
views
Meta Stack Overflow API Try-It form sends request to Stack Overflow API instead of Meta API
Meta Stack Overflow API Try-It form sends request to Stack Overflow API instead of Meta API
- 18.6k
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
1
vote
1
answer
75
views
Definitive on timeline_type?
Hi all,
I am trying to get a definitive on what timeline_type actually means...
I've looked at: https://stackapps.com/search?q=timeline_type but to no avail.
The new documentation doesn't list ...
CommunityBot
- 1
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.
- 18.6k
4
votes
2
answers
255
views
How to get a post title for a given post ID, even if that post ID is an answer and not a question?
I'm trying to beautify the reputation audit. If I want to show the post title for a reputation change event, however, I have a problem -- I don't know if the post ID is relative to a question or an ...
CommunityBot
- 1
5
votes
2
answers
188
views
API Help's CSS is missing
The API Help page's CSS file, located at http://sstatic.net/so/all.css, is current returning 404 for me:
<div id="header"><h1>Server Error</h1></div>
<div id="content">
...
CommunityBot
- 1
1
vote
1
answer
1k
views
Where is the API located?
I want to know where is the API located and from where to download?
CommunityBot
- 1
1
vote
1
answer
117
views
user 'about_me' field suggested_buffer_size is too small
the suggested_buffer_size of user.about_me is currently 3000.
it is apparent that this is the server-side field length.
the problem is that the text is stored server-side in markdown but when served ...
- 18.6k
2
votes
1
answer
125
views
Error Code when API Key Limit exceeds
What will the error code be generated when API Key Limit exceeds? I need that because I have to handle this error in my application.
CommunityBot
- 1
4
votes
1
answer
151
views
AND searching for tags?
I am using the search api to search for questions that are tagged with "tags" and not with "tags". However I have noticed that searching for tags is an OR search.
The questions search for tags is an ...
- 12.1k
9
votes
1
answer
1k
views
How to see which users upvoted a question?
I assume this information is tracked, since StackOverflow shows me the questions I have upvoted (when going to their question page, I can undo the upvote). I couldn't find any api call that gives this ...
- 18.6k
3
votes
0
answers
53
views
API Help Suggestion: /search - can we make tagged,nottagged description consistent with other list params
on most other params that accept a semi-colon delimited list we see
list of tags questions must have, semicolon delimited
A single primary key identifier or a vectorized, semicolon-delimited list of ...
- 12.1k
1
vote
1
answer
67
views
help page format issue: revisionGuid
http://api.stackoverflow.com/0.8/help/method?method=revisions/{id}/{revisionguid}
revisionGuid is inconsistent.
revisionguid seems appropriate (and will remove one special case from my api parser).
- 18.6k
1
vote
1
answer
61
views
help page format issue: missing parameter
/users/{id}/tags is missing id parameter
fixing this will remove one more special case from my parser.
- 18.6k
1
vote
1
answer
65
views
help page issue: revisions by revisionguid example needed
/revisions/{id}/{revisionguid} - usage of this route is not clear to me.
can someone provide a working url and perhaps a simple use case.
- 18.6k
1
vote
1
answer
97
views
Can we have all possible closed reasons in help page?
Can we have all possible closed_reasons in help page and if possible, closed_reason_id, too?
For example
closed_reason_id=1, closed_reason="exact duplicate",
closed_reason_id=2, closed_reason="off-...
- 18.6k
1
vote
1
answer
80
views
The user and owner objects appear to be optional in the question timeline result.
This is probably just a simple documentation fix and not really a bug. The doc for the /questions/{id}/timeline method says that the user and owner objects are not optional, but they aren't always ...
CommunityBot
- 1
4
votes
2
answers
124
views
Document fields that may be not be included in responses
I'd like to see documentation on what fields may not be included in responses or, alternatively, which fields are guaranteed to be included. Currently it's a little confusing because some fields may ...
- 18.6k
0
votes
1
answer
84
views
questions/{id}/timeline documentation: timeline_type values not listed
The timeline_type for post timelines just says "string" for the "values". From a cursory look at a few questions, I've seen the following types of events:
question
answer
comment
revision
votes
The ...
- 18.6k
2
votes
1
answer
99
views
questions/{id} help page sort parameter description is inconsistence with others
The description of the Sort parameter in questions/{id} help page is inconsistent with those of other pages.
On the questions/{id} help page:
sort (optional):
How a collection
should be ...
- 18.6k
3
votes
1
answer
118
views
Methods that return comments document body and comments parameters but they do nothing
Methods that return comments document the "body" and "comments" parameters, but they have no effect on the results, which cannot include comments and always include the body.
Specific methods:
/...
- 18.6k
4
votes
1
answer
132
views
Confirmation on sort, order and min/max
I'd like confirmation, if possible, that the following chart of sort types is correct:
sort |orderable|min/max |min/max type
------------------------------------------
activity | yes | ...
- 960
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 ...
- 18.6k
2
votes
1
answer
79
views
/users/{id} and /users/{id}/timeline - filter parameter?
Both /users/{id} and /users/{id}/timeline say they take a filter parameter for users' names, but it seems to do nothing. Are they not supposed to be there?
- 18.6k