Go to All Forums

API documentation feedback

Hello,

I've been working with the API recently and struggled a little with the documentation at www.site24x7.com/help/api/. The content is good, however there are a few issues:

  1. It is one huge web page and initial load makes the browser slow to a crawl.
  2. Searching relies solely on browser functionality, which doesn't scale to such a large web page.
  3. Navigating and knowing where you are is very difficult. This is particularly exacerbated when the same concept is repeated but in different contexts. Example, find "Web Page Speed" and you get different request and response objects, where the relationships are unclear. Some of the links seem to be pointing to the wrong places.
  4. There are JavaScript errors logged to the console.

Specifically on the request to create a new monitor of type "Web Page Speed", there is an attribute that has not yet been documented, "browser_type" as well as typos "images_threhsold", "scripts_threhsold", "css_threhsold". Doesn't look professional.

Regards,

Alex.

Like (2) Edit Delete Reply
Replies (1)

Re: API documentation feedback

Hi There, 

    We understand that the API help is a bit lengthy. We will work towards improving the performance and readability. 

>>> Navigating and knowing where you are is very difficult. This is particularly exacerbated when the same concept is repeated but in different contexts. Example, find "Web Page Speed" and you get different request and response objects, where the relationships are unclear. Some of the links seem to be pointing to the wrong places.

This has been fixed.

>>>Specifically on the request to create a new monitor of type "Web Page Speed", there is an attribute that has not yet been documented, "browser_type" as well as typos "images_threhsold", "scripts_threhsold", "css_threhsold".

Typos corrected.

-Jasper

PM, Site24x7 

Like (0) Reply

Was this post helpful?