When to Use GET

HTTP GET is the kind of request that is normally used to request a web page. This kind of request is not meant to send large amounts of data. The advantage of GET requests is that all data that is to be sent, is encoded within the URL itself. Therefore, the URL can be copied to other users, used as an iframe src, or saved as a browser bookmark.

When requesting formatted reports which are meant for immediate display rather than for further processing, GET is normally the best option. When using GET requests in order to include a report as part of a web page, one does not need to worry about how to do the request itself. The easiest way is to create an iframe and simply place the URL in the iframe src attribute.

All the examples within this documentation use POST requests. However, all requests other than POST /auth/login can be accessed via a GET request. To request a report via GET, the same URL should be called, and the JSON request object should be formatted in exactly the same way. However, instead of sending the JSON object as POST data, it should be sent URL encoded inside a parameter named query.