Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

Filter by
Sorted by
Tagged with
3 votes
1 answer
59 views

Events: field request

The "Event" object doesn't have an easy way for getting at the object relating to the event. There's a link field, but I don't fancy having to parse the information out of that (although I could). ...
Dave DeLong's user avatar
  • 5,264
3 votes
1 answer
204 views

OBSOLETE - /search method, returning the body of the questions

Probably this is a documentation fault. For the search method, the parameter list doesn't say anything about an optional body, but looking at the Returns description shows: "body": { "...
Dan Dumitru's user avatar
3 votes
2 answers
329 views

What am I allowed/not permitted to do with the API?

I have a site that will offer technical help and assistance for a certain niche of computer users. I can either host my own forums, or tie in with stack... but I want to be able to make money off it ...
makerofthings7's user avatar
3 votes
4 answers
276 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 ...
Steffen Opel's user avatar
  • 1,380
3 votes
2 answers
77 views

Inconsistency in the handling of multiple IDs with a duplicate

There appears to be some inconsistency in the way multiple ids are being handled, especially when a duplicate exists. Duplicate ID is significant For example, when requesting a timeline of multiple ...
coobird's user avatar
  • 133
3 votes
1 answer
83 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 ...
Jeremy Larter's user avatar
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 ...
amit jha's user avatar
  • 842
3 votes
1 answer
170 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 ...
amit jha's user avatar
  • 842
3 votes
1 answer
114 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 ...
Martijn Pieters's user avatar
3 votes
1 answer
65 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 ...
Nicholas DiPiazza's user avatar
3 votes
1 answer
225 views

API documentation console unsuccessfully tries to load MiniProfiler results

All of the documentation pages (example) with the test console currently attempt to load MiniProfiler result data, which fails with a 404: POST https://api.stackexchange.com/mini-profiler-resources/...
Tim Stone's user avatar
  • 4,686
3 votes
1 answer
96 views

Methods that return comments document body and comments parameters but they do nothing

Methods that return comments document the "body" and "comments" parameters, but they have no effect on the results, which cannot include comments and always include the body. Specific methods: /...
ColinD's user avatar
  • 369
3 votes
1 answer
241 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 ...
msftsofbot's user avatar
3 votes
1 answer
56 views

Documentation has broken link (JSONP)

On Wikipedia, JSONP now has its own article, instead of being part of the JSON article. The documentation links JSONP to Wikpedia:JSON#JSONP. It should link to Wikipedia:JSONP.
TRiG's user avatar
  • 133
3 votes
1 answer
65 views

What happened to the /stats method?

I can't find the /stats method in the new usage documentation. A quick run of http://api.stackoverflow.com/1.1/stats reveals that the method is still there. However, it is not documented.
Nathan Osman's user avatar
  • 23.3k
3 votes
0 answers
38 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 ...
NotTheDr01ds's user avatar
3 votes
0 answers
38 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....
Rakete1111's user avatar
3 votes
0 answers
54 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 :)
Rakete1111's user avatar
3 votes
0 answers
44 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 ...
Stijn's user avatar
  • 263
3 votes
0 answers
45 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.
Stijn's user avatar
  • 263
3 votes
0 answers
50 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://...
ForkandBeard's user avatar
3 votes
0 answers
79 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 ...
Dan Lugg's user avatar
  • 131
3 votes
0 answers
49 views

Always show console on API docs

This script stops you having to click the "show console" button to test an API call. Install - View Source
Gelatin's user avatar
  • 796
3 votes
0 answers
51 views

API Help Suggestion: /search - can we make tagged,nottagged description consistent with other list params

on most other params that accept a semi-colon delimited list we see list of tags questions must have, semicolon delimited A single primary key identifier or a vectorized, semicolon-delimited list of ...
Sky Sanders's user avatar
  • 12.1k
3 votes
1 answer
70 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 ...
Dennis Williamson's user avatar
2 votes
1 answer
49 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.
amit jha's user avatar
  • 842
2 votes
3 answers
75 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? ...
hippietrail's user avatar
2 votes
1 answer
108 views

Error Code when API Key Limit exceeds

What will the error code be generated when API Key Limit exceeds? I need that because I have to handle this error in my application.
chanchal1987's user avatar
2 votes
1 answer
87 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 ...
Glorfindel's user avatar
  • 6,762
2 votes
1 answer
77 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 ...
Glorfindel's user avatar
  • 6,762
2 votes
1 answer
101 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?
Nicholas DiPiazza's user avatar
2 votes
1 answer
169 views

How do I find all questions/answers per a tag?

Would also be good if I could also find the top questions/answers in a particular tag - i.e. questions tagged with Ruby or PHP. Per the docs the only thing I can see that will return questions in a ...
marcamillion's user avatar
2 votes
1 answer
39 views

Confusing documentation re vectorized requests limits

The documentation for vectorized requests says this: Most methods that take ids in the Stack Exchange API will take up to 100 of them in a single go. This allows applications to batch work and ...
hippietrail's user avatar
2 votes
1 answer
51 views

Minor spello/typo on the "Complex Queries" documentation page

The documentation page Complex Queries has a minor typo or spello: The ?filter=total build-in filter is provided for just this purpose. Should instead be: The ?filter=total built-in filter ...
hippietrail's user avatar
2 votes
2 answers
664 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": { ...
YOU's user avatar
  • 5,022
2 votes
1 answer
50 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 ...
Ayer AGG'TDd'E-A's user avatar
2 votes
1 answer
66 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 ...
Makyen's user avatar
  • 1,615
2 votes
1 answer
58 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 ...
Rakete1111's user avatar
2 votes
1 answer
81 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, ...
Oldskool's user avatar
  • 121
2 votes
1 answer
64 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.
amit jha's user avatar
  • 842
2 votes
1 answer
86 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?
Ionică Bizău's user avatar
2 votes
1 answer
152 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 ...
aldrin's user avatar
  • 155
2 votes
1 answer
63 views

Where can I request an API key in the docs?

Can you mention the possibility of requesting an API key in the docs? It was displayed for the 1.0 API.
PeeHaa's user avatar
  • 315
2 votes
1 answer
114 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 ...
Sky Sanders's user avatar
  • 12.1k
2 votes
1 answer
67 views

questions/{id} help page sort parameter description is inconsistence with others

The description of the Sort parameter in questions/{id} help page is inconsistent with those of other pages. On the questions/{id} help page: sort (optional): How a collection should be ...
YOU's user avatar
  • 5,022
2 votes
1 answer
99 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.
Peter Mortensen's user avatar
2 votes
1 answer
97 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, ...
ashleedawg's user avatar
2 votes
1 answer
64 views

No token field in the docs test page for /me/reputation-history

There is no form field for an access token at: https://api.stackexchange.com/docs/me-reputation-history https://api.stackexchange.com/docs/me-full-reputation-history After attempting to Run the API ...
pb2q's user avatar
  • 123
2 votes
1 answer
60 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.
Adam's user avatar
  • 809
2 votes
1 answer
27 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
Charles Sprayberry's user avatar