API Documentation | Outlier Report

Provides API access to OutlierReport objects.

Fields

_cid string
The primary key
"/outlier_report/1234"
A string containing a outlier_report cid
_created number
The point in time when this object was created
1473460702
A positive integer that contains the number of seconds since the UNIX epoch (midnight on January 1st, 1970 in Greenwich, United Kingdom)
_created_by string
User who created the outlier report
"/user/1234"
A string containing a user cid
_last_modified number
The point in time when this object was last updated.
1473461583
A positive integer that contains the number of seconds since the UNIX epoch (midnight on January 1st, 1970 in Greenwich, United Kingdom)
_last_modified_by string
User who last modifed the outlier report
"/user/1234"
A string containing a user cid
config string
Extended configuration of outlier reports. A json object.
{}
A string containing freeform text
metric_cluster string
cid of the metric cluster that the outlier report is based on
"/metric_cluster/514"
A string containing a metric_cluster cid. Required
tags array
Tag(s) assigned to the outlier report
["datacenter:home"]
An array of tags. The tags in the array are automatically sorted, deduplicated and transformed into their lowercase canonical form.
string (zero or more times)
An associated tag
A tag is just a string, with or without a colon, such as 'foo', 'bar', 'datacenter:london', or 'os:linux'. The part of the string before the colon is considered the category the tag is in; Tag strings without a colon will place the string in the 'uncategorized' category. Circonus will lowercase the contents of the string before storing it.
title string
The title of the outlier report.
"Outlier Report"
A string containing freeform text

Example

Fetching Outlier Reports

Fetching an outlier report is as simple as performing a GET on the outlier report cid:

GET /outlier_report/1234
{"config":{},"_created_by":"/user/609","_cid":"/outlier_report/1234","_created":1473460702,"title":"Outlier Report","_last_modified_by":"/user/609","metric_cluster":"/metric_cluster/514","_last_modified":1473461583,"tags":["datacenter:home"]}

From this we can see:

Creating Outlier Reports

Creating a new outlier report is as simple as making a HTTP POST request to /outlier_report and passing JSON representing the report configuration:

POST /outlier_report
{"tags":["datacenter:home"],"metric_cluster":"/metric_cluster/514","title":"Outlier Report"}

Updating Outlier Reports

Updating an outlier report is as simple as making a HTTP PUT request with the report's cid and passing JSON representing the new configuration:

PUT /outlier_report/1234
{"title":"Outlier Report","metric_cluster":"/metric_cluster/608","tags":["datacenter:home"]}

Listing Outlier Reports

Outlier Reports can be listed simply by performing a GET request on /outlier_report.

GET /outlier_report
[{"_created_by":"/user/609","_cid":"/outlier_report/1324","config":{},"_last_modified":1473461583,"metric_cluster":"/metric_cluster/514","tags":["datacenter:home"],"title":"Outlier Report","_created":1473460702,"_last_modified_by":"/user/609"}]

Deleting Outlier Reports

You can delete an outlier report by performing a DELETE on the report's CID:

DELETE /outlier_report/1234