All Questions
Tagged with api-help or documentation
147 questions
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
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
0
answers
76
views
Improve design of the Documentation's 404 page
The 404 page of the documentation has a rather awkward design; for example, a different header than other pages, and no footer. Can it be updated?
- 6,965
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
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
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
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
0
answers
67
views
Spelling mistake in API Documentation's "Authentication" page
Can you find the spelling mistake in "Unregistered Users" (last section) of the Authentication page?
In case you're not in the mood for games, here is it:
- 256
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
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
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
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
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
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
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
- 5,042
1
vote
1
answer
152
views
What license is the Stack Exchange API released under? MIT?
Are there any license requirements the Stack Exchange API?
Which license is it released under?
If I were to develop an app, would I have to credit Stack Exchange API?
- 113
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
1
vote
1
answer
1k
views
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
1
vote
1
answer
64
views
`types=main_site` in `/me/associated` gives `meta_site` accounts also
When I run /me/associated with main_site as a parameter in types, its gives meta_site accounts also (Meta Stack Exchange profile).
- 834
1
vote
1
answer
123
views
What is the private_info scope for?
In the docs it says you can pass private_info for scope when authenticating a user.
What does this allow you to access, that you couldn't otherwise?
- 3,108
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
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
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
1
vote
1
answer
74
views
CDN redirect for the API's JavaScript SDK is incorrect
The API's JavaScript SDK is listed as https://api.stackexchange.com/js/2.0/all.js.
However, GET request produces the following response:
Status Code: 301 Moved Permanently
Location: https://api-...
- 175
1
vote
1
answer
107
views
How do I find a user by their `display_name`?
I am using Serel (the Ruby wrapper) and would like to be able to find a user by their display_name.
As it stands right now, I can only find them via an ID - like Serel::User.find(1,2,3).
I tried ...
- 143
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
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
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
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
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
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
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
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
1
vote
0
answers
79
views
The authentication doc gives a wrong domain for authentication
The authentication doc page now lists URL's like:
https://stackoverflow.com/oauth
https://stackoverflow.com/oauth/access_token
etc.
While these seem to work, the correct domain is stackexchange.com, ...
- 13k
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
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
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
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
0
votes
2
answers
136
views
Ajax get questions by tags ERROR
i'm trying getting questions by tags.
this is my simple code and i'm running this from my http://localhost:
<script type="text/javascript">
$(function(){
$.ajax({
url:'http://api....
- 115
0
votes
1
answer
75
views
Support for OR constraint when querying questions based on tags [duplicate]
Right now, there is no way (as far as I know) to query for questions based on multiple tags using an OR constraint.
You can query for questions tagged with multiple of these tags, but not with one or ...
- 103
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
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....
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
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