As of May 31, 2023, we have updated our Code of Conduct.
4 votes
Accepted

“Try It” URL has wrong URI

The link is correct. The purpose of that control is to provide a URL to the doc page with all the parameters prefilled. This is what most users expect and is similar to how that link control works ...
Brock Adams's user avatar
  • 12.8k
4 votes
Accepted

Clickable link in "Try It" section of some doc pages

The routes that don't link require POST requests because they create context, so there's nothing meaningful to be gained by going to those URLs in your browser. The rest of the routes return data ...
Tim Stone's user avatar
  • 4,706
4 votes
Accepted

Where is "items" & "badge_counts" documentation?

items is documented in the Common Wrapper Object. It is an array of whichever object the given route returns. In the case of /me/associated,  items is an array of network_user objects. If you ...
Brock Adams's user avatar
  • 12.8k
4 votes

Please make the site search on the API alphabetical

If this doesn't happen, this simple script will do it for you!: $('.site-picker.ui-autocomplete-input').on('input', function() { setTimeout(function() { var mylist = $('body > ul.ui-...
ᔕᖺᘎᕊ's user avatar
  • 4,365
4 votes

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

The original intent of these options is clearly not to enable automated flagging, but rather to allow an application to generate a UI that presents the applicable options to a user who would be ...
Shog9's user avatar
  • 641
4 votes

Please "release" and/or document API version 2.3

Note that version 2.3 has been around since at least Aug 28, 2015 (Date of that answer). I could have sworn that one of the SE guys said they weren't going to document it, but can't find a reference ...
Brock Adams's user avatar
  • 12.8k
3 votes
Accepted

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

API access and capabilities depend on the tier of Stack Overflow for Teams that you are subscribed to. Free - No API access Basic - Read-only API access Business - Read and Write API access The ...
Juice's user avatar
  • 186
3 votes
Accepted

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

The key mistake here is neglecting the Wrapper Object, and this is a big flaw with the filter documentation. The wrapper is the box that everything you get from the API comes in. You always get the ...
Brock Adams's user avatar
  • 12.8k
3 votes

Why is "body" missing from certain inbox items?

The documentation was updated sometime in the last 2 years and the API docs (version 2.2) now state that the property may be absent:
Brock Adams's user avatar
  • 12.8k
3 votes

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

This is a documentation bug in my opinion. The "via Example App" was never included, nor should it be. A user is fully responsible for his or her content, it doesn't, and shouldn't, matter how that ...
Brock Adams's user avatar
  • 12.8k
3 votes
Accepted

Typos in API documentation

These were just fixed in the latest build.
Taryn's user avatar
  • 191
3 votes

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

The official documentation is here: Available flags vary from object to object, user to user, and site to site. An application should not assume that particular flags are always available, or that ...
Undo's user avatar
  • 1,025
2 votes
Accepted

What does "in practice" mean here?

Strictly speaking, that line is incorrect. The method will always return a JSON object (barring certain server failures). But the items array will be empty or missing. On success, the default ...
Brock Adams's user avatar
  • 12.8k
2 votes
Accepted

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

Ok, this'll be corrected after the next API build.
Shog9's user avatar
  • 641
2 votes

Application Key and AccessToken are not working for Stack Exchange API?

In my particular case, I somehow managed to append % character to the end of the access_token. There should be no % character at the end of the access_token.
Gajus's user avatar
  • 163
2 votes

Notice field on questions may be absent?

Yes, officially this is a documentation bug. From the Absent Fields doc: Fields that are not always guaranteed to be set... are indicated in the per-type documentation. Any discrepency(sic) ...
Brock Adams's user avatar
  • 12.8k
2 votes
Accepted

Few typos in the documentation pages

The fixes for this were just pushed in the latest build. Thanks for reporting it.
Taryn's user avatar
  • 191
2 votes
Accepted

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

Fixed, thanks to ᔕᖺᘎᕊ, for bringing it to my attention, rolling out in next API build.
m0sa's user avatar
  • 196
2 votes
Accepted

`fromdate` and `todate` parameter in `/me` call

Yes, if you omit those parameters it will give you the expected result... If a valid token is passed, then it will return the user ("There can be only one.") who obtained/approved that token. For ...
Brock Adams's user avatar
  • 12.8k
2 votes
Accepted

Why is the `site` parameter required in `/me` call?

RE: Is site the api_site_parameter of the site object? Yes.   Although as stated in the "Per-Site Methods" section of the main doc page, you can also use the full domain name, EG cooking....
Brock Adams's user avatar
  • 12.8k
2 votes
Accepted

`types=main_site` in `/me/associated` gives `meta_site` accounts also

This is exactly how it should be (except that the doc page might be more explicit). The meta_site parameter refers to Per-site Metas. Meta Stack Exchange is not a per-site meta. Think of it as a ...
Brock Adams's user avatar
  • 12.8k
2 votes
Accepted

The /tags query is not giving me the correct results between two dates?

This sure looks like a bug. Site search shows that there were 946 browserify questions created in 2015 (so far). The /tags route doesn't have a created option, but it shows 0 questions were active in ...
Brock Adams's user avatar
  • 12.8k
2 votes
Accepted

link in post_id in /me/notifications/unread is wrong

This is a very minor bug in the documentation page. The online doc page adds a convenient hyperlink to the post (The link part is not in the API's JSON response). That's a good thing. Most of the ...
Brock Adams's user avatar
  • 12.8k
2 votes
Accepted

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

There is no difference and... The inbox has always been "The global inbox". Certainly for as long as the API has existed. So any inbox route will be Stack Exchange wide, even if it accepts a site ...
Brock Adams's user avatar
  • 12.8k
2 votes

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

The values for the question and answer flag_option title properties, which I've determined experimentally, are: const flagTypes = { /* Localizations: * English (not localized) * ...
Makyen's user avatar
  • 1,575
2 votes

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?

You can find a lot in the questions tagged faq, and the API has a comprehensive documentation with the option to test your calls online. The best guide here (that I know of) to what a script is (on ...
Glorfindel's user avatar
  • 6,487
1 vote
Accepted

Unable to post a comment using the interactive API documentation

When using the API to add/edit posts or comments, you need to ensure the preview parameter is set to false, otherwise it's just a 'test' request which does nothing (but allows you to test if the ...
Glorfindel's user avatar
  • 6,487
1 vote

Wrong sorting parameter in documentation for question/{ids}/answers

No, I think this is intentional. The word on the left side is the value of the sort parameter: while the word on the right side is a field name of the answer object:
Glorfindel's user avatar
  • 6,487
1 vote

"Javascript" typo on documentation pages

This was just fixed in the latest build. Thanks for the report.
Taryn's user avatar
  • 191

Only top scored, non community-wiki answers of a minimum length are eligible