API Documentation | Caql
The CAQL API endpoint provides a way to extract data from Circonus using a CAQL query.
To extract data, perform an HTTP GET request to /caql including the following query parameters:
- A well-formed CAQL query
- The start time, in epoch seconds, of the duration you wish to query data from
(default: 60 seconds before
- The end time, in epoch seconds, of the duration you wish to query data from
(default: 5 minutes before the current time rounded to the nearest minute)
- The resolution of data, in seconds, you want to get back
In addition to specifying metrics by Check UUID and Metric Name, you can use the CAQL Search Package to find matching metrics. In the following example, we search for data from all Checks having a "duration" metric:
See the CAQL Reference Manual for a full description of the CAQL syntax and packages available.