Questions tagged [documentation]
Question pertaining to the documentation provided with the API.
147 questions
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
8
votes
0
answers
207
views
Incomplete information in API documentation
I am struggling a little bit with the Stack Exchange API since there seems to be no formal specification for the individual endpoints of the API.
Example:
Endpoint: https://api.stackexchange.com/2.2/...
- 533
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
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
3
votes
1
answer
129
views
Why is "body" missing from certain inbox items?
I have run into some confusion over the presence of the body attribute in an inbox-item returned by the /inbox method.
When item_type is set to "careers_invitations", the body attribute appears to be ...
- 23.2k
3
votes
0
answers
97
views
SE API V1.1 documentation, date errata
The Stack Exchange API, version 1.1, documentation is ever so slightly confusing wherever Unix timestamps are mentioned (perhaps any ranges, I haven't dug too deeply)
For instance:
todate – Unix ...
- 131
4
votes
2
answers
136
views
Possible bug in the help page?
There are some weird dot things in this help page:
api.stackoverflow.com/0.8/help/method?method=users/{id}/badges
{Dead link to missing image: http://files.quickmediasolutions.com/stackbug.png}
...
- 23.2k
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
3
votes
0
answers
58
views
Types missing from the "Member Types" section
The following types are not listed on http://api.stackexchange.com/docs?tab=category#docs under the Member Types section:
network_post
closed_details
original_question
Note that it's a nonexhaustive ...
- 273
3
votes
4
answers
350
views
Is it really worth to (implicitly) discourage documentation of API/library usage nowadays already?
Update:
Kevin provided an answer, which, while adding something of value to the three related questions together (by naming the originating concern eventually), actually does not apply to the ...
- 1,380
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 ...
4
votes
0
answers
145
views
Parameter `tagged` in `search/advanced` seems to use `AND` instead of `OR`
It seems that search/advanced has the same problem as in "The tagged parameter does not work with multiple tags" question.
When I select c#; .net I only get results tagged both c# and .net:
http://...
- 175
1
vote
1
answer
1k
views
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 ...
- 872
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 ...
- 945
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
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?
4
votes
1
answer
103
views
"Try it" facility suffers a double-encoding bug
As you can clearly see from the above, the ampersand in the site name in the "Try It" section of the API method documentation has been double-encoded. This affects any site with an ampersand in the ...
5
votes
1
answer
121
views
Enumerated types documentation in 1.1 API
I'm starting to implement requesting question and user activity in my framework, but the new 1.1 API documentation doesn't seem to indicate what the possible return values are for the fields any more.
...
- 5,264
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
2
votes
1
answer
108
views
Top questions by tag and period
I want to get via API the most voted questions from the latest week (for example) from a specified tag (php, for example).
How can I do this?
- 343
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">
...
- 819
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
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 => ...
- 5,264
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