All Questions
Tagged with documentation documentation or
150 questions
3
votes
0
answers
40
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....
- 13k
3
votes
1
answer
93
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 ...
3
votes
0
answers
56
views
Authorization dialog shows wrong API version
If you go on this doc page and click on Get Token, you'll see this:
Minor bug, but still, I thought it would be nice to fix this inconsistency :)
- 13k
2
votes
0
answers
31
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.
4
votes
1
answer
185
views
“Try It” URL has wrong URI
On API doc pages, the “link” link at the top-right of the “Try It” sections presents a URL with the wrong domain name:
For example, on docs/similar, the URL displayed will be:
https://api....
- 4,676
2
votes
1
answer
156
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 ...
- 13k
4
votes
0
answers
55
views
'answer' type has "unchanged in unsafe filters" listed for the wrong field
http://api.stackexchange.com/docs/types/answer says the can_flag field is unchanged in unsafe filters. It's probably meant for the field above it: body_markdown.
2
votes
0
answers
23
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
3
votes
0
answers
46
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
4
votes
0
answers
122
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://...
CommunityBot
- 1
7
votes
1
answer
683
views
Application Key and AccessToken are not working for Stack Exchange API? [duplicate]
I have followed the documentation and used explicit OAuth 2.0 flow for access_token generation.
And I have gone through all 4 steps defined under explicit OAuth 2.0 flow with scope=no_expiry. Then I ...
CommunityBot
- 1
2
votes
1
answer
82
views
Notice field on questions may be absent?
The notice type, that is a field of a question, appears to be optional, yet it is not marked as "may be absent"?
For example, when I request questions with a filter that has the notice field checked, ...
- 13k
1
vote
1
answer
95
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 ...
CommunityBot
- 1
1
vote
1
answer
50
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).
CommunityBot
- 1
2
votes
1
answer
68
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.
CommunityBot
- 1
32
votes
1
answer
11k
views
Looking for a beginner's tutorial to using the API
I see the Stack Exchange API but I'm unable to understand it. I don't think there is any fundamental tutorial showing how to use Stack Overflow fully in the API documentation.
I want some fundamental ...
CommunityBot
- 1
3
votes
1
answer
88
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 ...
CommunityBot
- 1
5
votes
1
answer
92
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.
...
CommunityBot
- 1
3
votes
1
answer
60
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 ...
- 13k
3
votes
1
answer
38
views
Clickable link in "Try It" section of some doc pages
In the "Try It" section of some doc pages, the link is not present.
It is present in the below image
Its not present in the below image
CommunityBot
- 1
2
votes
1
answer
55
views
Where is "items" & "badge_counts" documentation?
Where is the items & badge_counts documentation?
This is returned as JSON. I am using the /me/associated query function.
CommunityBot
- 1
5
votes
1
answer
78
views
Please make the site search on the API alphabetical
When I search, I want the sites to be alphabetical:
Please can they be?
CommunityBot
- 1
5
votes
1
answer
75
views
Which reputation events are private?
I've been reading the API documentation on retrieving a user's reputation history (docs/types/reputation-history)
and Stack Overflow's description of how reputation is calculated.
But, I can't find ...
CommunityBot
- 1
1
vote
1
answer
84
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 ...
- 13k
7
votes
1
answer
127
views
What happened to the JSON documentation for the API?
Back in version 1.1 of the API, we used to be able to do:
http://api.stackoverflow.com/1.1/questions?help
...which would return information about the method in JSON format. However, attempting to ...
- 13k
3
votes
4
answers
283
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 ...
CommunityBot
- 1
2
votes
3
answers
76
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?
...
0
votes
1
answer
66
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 ...
- 4,676
1
vote
1
answer
80
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.
CommunityBot
- 1
2
votes
1
answer
89
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 ...
2
votes
1
answer
117
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 ...
- 13k
0
votes
1
answer
98
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 ...
- 13k
1
vote
1
answer
83
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 ...
- 13k
5
votes
1
answer
78
views
API documentation pages match some site names incorrectly
The bug is not in the API itself, but in the pages documenting its methods. To reproduce, follow the link http://api.stackexchange.com/docs/info#filter=default&site=math and observe that the page ...
- 18.7k
2
votes
0
answers
64
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 ...
CommunityBot
- 1
1
vote
0
answers
64
views
Get Token button in "Try it" doesn't give me a key in IE11
When I visit for example the timeline docs to try that api I need to get a token first by clicking 'Get Token'.
In IE11 (win 7/x64) this is broken. A window does pop-up but there is never a key ...
rene♦
- 2,762
1
vote
1
answer
78
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 ...
- 4,676
1
vote
1
answer
89
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 ...
CommunityBot
- 1
4
votes
1
answer
82
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 ...
- 18.7k
1
vote
1
answer
86
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?
CommunityBot
- 1
3
votes
0
answers
52
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://...
CommunityBot
- 1
4
votes
0
answers
41
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 ...
CommunityBot
- 1
18
votes
1
answer
278
views
Accessing Authenticated User's Close/Delete History
I'm working on the PHP chatroom's cv-pls backlog UI. Many users and myself would like the ability to track which questions we have already handled though close/delete votes. To be able to do that I ...
- 13k
0
votes
1
answer
52
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 ...
- 18.7k
2
votes
1
answer
61
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.
CommunityBot
- 1
2
votes
1
answer
89
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
4
votes
1
answer
288
views
How do I parse the dates from the API?
I see that JSON returned by the API contains dates in the following format:
"creation_date":1364546475
^^^^^^^^^^
What's the meaning of it? How can I parse it to get the date in the ...
CommunityBot
- 1
3
votes
1
answer
68
views
In the API, User object, what are all these reputation properties?
I am going through the JSON that is resulting from calling the Stack Exchange User API.
I see a bunch of reputation fields.
private Number reputation;
private Number reputation_change_day;
private ...
CommunityBot
- 1
2
votes
2
answers
927
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": {
...
CommunityBot
- 1
1
vote
1
answer
64
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-...
- 18.7k