Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

Filter by
Sorted by
Tagged with
0 votes
0 answers
9 views

Strange grammar in API docs /js-lib

* This is kind of like an extension to Typos on api.stackexchange.com/docs/js-lib https://api.stackexchange.com/docs/js-lib version is provided for bug reporting purposes, few client's will use it ...
1 vote
0 answers
20 views

Typo in API docs /numbers)

https://api.stackexchange.com/docs/numbers The motivation for this is to prevent any unpleasant floating point confusion, especially across technologies that offering different floating point ...
1 vote
1 answer
63 views

Clarify read-only vs. write operations for Teams in documentation

The API page about Stack Overflow for Teams 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 ...
  • 5,614
1 vote
1 answer
31 views

Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, incl. differences between them?

Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, including differences between them? Basically, I'm looking for onboarding documentation ...
0 votes
0 answers
20 views

Auto-links to collectives in documentation aren't working

The Collective objects returned by the API, e.g. this method, have a link property that seems to be clickable, just like post and comment IDs in other object types: However, they lead to links like ...
  • 5,614
3 votes
0 answers
27 views

Browsing method documentation consumes 4 quota units per page

Is it my imagination (scratch that, it's definitely not), or does simply browsing method doc pages (without using the "Run" function) consume quota? From Bash using httpie and jq (on a ...
2 votes
0 answers
54 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 ...
  • 5,614
2 votes
1 answer
223 views

Unable to post a comment using the interactive API documentation

I'm trying to to integrate the Stack Exchange API in my application. I'm trying the authentication but when I got the token and used it it gave a write_access issue. That issue was resolved when I ...
1 vote
1 answer
63 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
2 votes
1 answer
63 views

What happened to the links to a Stack App mentioned in the documentation about write access?

The documentation about write access states: The application responsible for creating content via the API may be indicated with a link to an app's Stack Apps post. The exact manner of display is ...
  • 5,614
2 votes
0 answers
43 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 ...
  • 5,614
1 vote
0 answers
63 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, ...
  • 12.7k
2 votes
1 answer
92 views

"Javascript" typo on documentation pages

On page Usage of /sites, it should be JavaScript, not Javascript, in the right sidebar: This obviously also applies to (most/all) API documentation pages, since they share the sidebar.
6 votes
1 answer
388 views

Please "release" and/or document API version 2.3

I was playing around a bit with Fiddler to capture traffic from the Stack Exchange iOS app. To my surprise, it uses version 2.3 of the Stack Exchange API: I noticed here that it has some extra ...
  • 5,614
2 votes
0 answers
30 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): ...
  • 5,614
9 votes
1 answer
121 views

Typos in API documentation

From the /posts documentation: Most applications should use the question or answer specific methods, but /posts is available for those rare cases where any activity is of intereset. intereset => ...
  • 5,614
2 votes
1 answer
62 views

What are the top level question & answer localized flag_option titles?

For the SE API, the endpoints dealing with flags (e.g. /questions/{id}/flags/options) return the flag_option type. However, the option_id values are explicitly stated as being unstable, but it's ...
  • 1,423
1 vote
1 answer
81 views

Can the API Edit a Question, changing only one field?

The documentation for the edit question method (/questions/{id}/edit) is somewhat vague. Are all of the parameters required? For example, if the only field I want to change in the question is tags, ...
6 votes
0 answers
55 views

Docs say the API returns a user's age, but it doesn't (anymore)

The doc page says that the user object returns an age property (for those users that specified an age). But the API  no  longer  does.   (Plus spot checks of users that had age in ...
  • 12.7k
2 votes
0 answers
41 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: This is actually a correct spelling - of ...
4 votes
1 answer
295 views

My filter is not returning any results. How to create a minimal filter?

I'm having trouble getting the SO API Filters to cooperate. I've gone over the documentation as well as similar questions like this and this. I'll use this call as an example since it successfully ...
2 votes
1 answer
55 views

What does "in practice" mean here?

From /answers/{id}/delete: In practice, this method will never return an object. For me, "in practice" means that the method will maybe return an object. But why? That's not good from an ...
3 votes
0 answers
32 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....
3 votes
0 answers
48 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 :)
4 votes
1 answer
164 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....
20 votes
3 answers
130 views

Documentation or API method for `option_id` information, for the `/flags/options` API calls?

The Stack Exchange API has a couple of calls that return a list of flag_option objects. These objects contain a couple of properties that can be used to identify the flag you need. For example, when ...
  • 301
2 votes
0 answers
22 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 ...
  • 263
3 votes
0 answers
36 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 ...
  • 263
2 votes
0 answers
30 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.
  • 263
3 votes
0 answers
39 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.
  • 263
2 votes
1 answer
80 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, ...
  • 121
5 votes
1 answer
161 views

Few typos in the documentation pages

https://api.stackexchange.com/docs/vectors When passing a vector, sepeate each id with a semicolon. For example, /users/1;2;3;4;5?site=somesite would fetch users with ids 1 through 5 on somesite. ...
  • 556
5 votes
1 answer
119 views

Typos on api.stackexchange.com/docs/js-lib

Under the Authentication section on https://api.stackexchange.com/docs/js-lib, there are a few typos (emphasis mine): scope (optional) – an array of scopes to request during authentication, valid ...
  • 4,295
2 votes
1 answer
61 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.
  • 822
1 vote
1 answer
89 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 ...
  • 822
1 vote
1 answer
43 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).
  • 822
3 votes
1 answer
79 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 ...
3 votes
1 answer
57 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 ...
  • 822
3 votes
1 answer
163 views

Difference between `/inbox/unread` & `/me/inbox/unread`

I ran /inbox/unread & /me/inbox/unread. What is the difference between the two? Also, the site parameter which we give in call to /me/inbox/unread is not required as inbox_item refers to global ...
  • 822
3 votes
1 answer
37 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
  • 822
2 votes
1 answer
45 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.
  • 822
5 votes
1 answer
72 views

Please make the site search on the API alphabetical

When I search, I want the sites to be alphabetical: Please can they be?
  • 571
5 votes
1 answer
66 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 ...
  • 153
5 votes
0 answers
107 views

"What is meta" should be rephrased

Stackapps.com/help/whats-meta tells that there is "Meta Stack Apps". However there isn't. Stack Apps is its own meta and meta is used to ask meta questions here.
  • 396
3 votes
1 answer
107 views

top-answerers / top-askers documentation bug: number of results returned incorrect

The top-answerers-on-tags and top-askers-on-tags documentation claim: Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days. and Returns the top 30 askers ...
7 votes
1 answer
670 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 ...
  • 305
0 votes
1 answer
56 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 ...
  • 305
5 votes
1 answer
64 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 ...
1 vote
0 answers
63 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 ...
  • 1,945
8 votes
0 answers
136 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/...
  • 513