{% extends "rest_framework/api_basics.html" %}

{% block description %}

<p>
The InfiniMetrics API returns JSON responses by default. It is however possible to ask for responses in CSV format.
This is particularly desirable when downloading raw monitored entity data, which can potentially include a large
number of records.
</p>
<p>
A CSV response can be requested by appending <code>?format=csv</code> to the URL, or sending the following request header:
<code>Accept: text/csv</code>.
</p>

<h3>Pagination</h3>

<p>
CSV responses are paginated just like JSON responses, but the response body does not include any
metadata information. Instead, the current page and total number of pages appear in the filename contained in the
<code>Content-Disposition</code> response header, for example:
</p>

<pre>
Content-Disposition: attachment; filename="systems_1007_monitored_entities_1_data.<b>page_3_of_17</b>.csv"
</pre>

<p>
Additionally, the <code>Link</code> header provides the URLs of the next and/or previous result pages. Other metadata
fields are also made available via custom response headers:
</p>

<pre>
<b>GET</b> https://infinimetrics/api/rest/systems/1007/monitored_entities/1/data/?page=2&page_size=10000&format=csv
</pre>

<pre>
HTTP 200 OK
Vary: Accept
Allow: GET, HEAD, OPTIONS
Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="systems_1007_monitored_entities_1_data.page_2_of_17.csv"
<b>Link</b>: &lt;https://infinimetrics/api/rest/systems/1007/monitored_entities/1/data/?page=1&page_size=10000&format=csv&gt;; rel="previous",
      &lt;https://infinimetrics/api/rest/systems/1007/monitored_entities/1/data/?page=3&page_size=10000&format=csv&gt;; rel="next"
<b>X-Page</b>: 2
<b>X-Page-Size</b>: 10000
<b>X-Pages-Total</b>: 17
<b>X-Number-Of-Objects</b>: 167673
</pre>

Next: <a href="/api/docs/examples/">Usage Examples &raquo;</a>

{% endblock %}