...
Use the GET method to pass report parameters in a query string. Authenticate the request using a generated token.
Example request
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/url-to-api?parameter=value¶meter2=other_value" |
...
This filter lets you either specify equality (default) or a range operator, but not both.
| Operator | Number | Date | Date and time |
|---|---|---|---|
| eq | equal to ${operator_value} | during day ${operator_value} | |
| lt | less than ${operator_value} | before day ${operator_value} | before hour 00:00 of day ${operator_value} |
| gt | less than ${operator_value} | after day ${operator_value} | after hour 23:59 of day ${operator_value} |
Example 1: Hour used (hu) between e and π will match 2.72, 3 and 3.14, but will not match 2.7183 or 3.1415.
...
If the URL ends with /csv, /xlsx or /pdf it will return a file in the corresponding format, as described below.
| Type | MIME type | Description |
|---|---|---|
| csv | text/csv | Semicolon-separated values. Records separated by Windows line separator (CRLF) |
| xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office 2007 spreadsheet format |
| application/pdf | Adobe PDF format |