All Questions
Tagged with api-help or documentation
147 questions
0
votes
1
answer
112
views
/questions/tagged/{tags} - tags param clarification
This API method has been removed as of Jul 16 '10. The original question is preserved below for posterity.
It is not clear what a "list" of {tags} looks like.
Does this parameter follow the ...
- 12.1k
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.
- 249
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
1
vote
1
answer
108
views
/users/{id}/badges id parameter clarification
On /users/{id}/badges, the description of the id parameter
a semicolon delimited list of user ids
diverges from the inferred standard for multi-valued parameters:
A single primary key identifier or ...
- 12.1k
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
1
vote
1
answer
106
views
Position required parameters at the top of help pages
The required id parameter for ...a lot of API routes... is now placed at the bottom of the page.
It makes more sense to place required parameters at the top of the page with a slight separation, like ...
- 12.1k
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.
- 315
1
vote
1
answer
100
views
`type=jsontext` JSON results for help pages
It would greatly simplify machine reading if we could apply type=jsontext to API help pages, including the index.
Update: Here's an unofficial JSON schema for v1.x.
- 12.1k
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
1
answer
68
views
Mistake in API 2.0 Documentation - Wrong item type for Careers Message
On https://api.stackexchange.com/docs/types/inbox-item the Careers Message example shows the wrong item type.
- 809
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
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 ...
- 872
6
votes
0
answers
69
views
API docs for "stack overflow" still feature v1.0 docs
I guess I'd call this a doc bug.
Currently the page http://api.stackoverflow.com redirects to http://api.stackoverflow.com/1.0/usage, which says at the top "Don't use 1.0, use 2.1". This URL ...
- 161
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 ...
- 872
2
votes
1
answer
113
views
Include range [1, 100] on pagesize
I see that "range" is being used to indicate valid range on most numeric parameters, e.g.
32-bit integer, range [0, 2,147,483,647]
32-bit integer, range [1, 2,147,483,647]
The smaller valid range for ...
- 12.1k
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 ...
- 157
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
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
4
votes
0
answers
56
views
Link to applied_count leads to a 404
To Reproduce
Run an API query on tag-synonyms, you will get a result that includes something like this:
Issue(s)
Click on the applied_count link and you get redirected to this page which is a 404.
It ...
- 141
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 ...
- 369
1
vote
1
answer
104
views
Please supply working example URLs for each route
It would take a lot of the guess work out of understanding the API if each route's page provided a small handful of working URLs.
This would also serve to provide authoritative examples of the ...
- 12.1k
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 ...
- 465
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 | ...
- 369
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....
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:
/...
- 369
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 ...
- 147
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
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.
- 133
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 ...
- 12.1k
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?
- 103
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 ...
- 5,042
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.
- 111
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 ...
- 3,305
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-...
- 5,042
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 ...
- 12.1k
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".
user451
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 ...
- 23.2k
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 ...
- 369
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 ...
- 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).
- 12.1k
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?
- 369
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
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.
- 12.1k
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.
- 12.1k
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
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
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.
- 12.1k