Analytics Settings

The following properties let you collect all analytic data, set the number of hours of data to retain, and set a hostname lookup policy.

Name Description retain_second_data Retention interval in hours for per-second data retain_minute_data Retention interval in hours for per-minute data retain_hour_data Retention interval in hours for per-hour data hostname_lookup Hostname lookup policy

Get Settings

Gets the current values of analytics setting properties.

Example Request:

GET /api/analytics/v1/settings HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Accept: application/json

Example Results:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 131
X-Zfssa-Analytics-Api: 1.0

{
    "settings": {
        "href": "/api/analytics/v1/settings",
        "retain_hour_data": 600,
        "retain_minute_data": 400,
        "retain_second_data": 200,
        "hostname_lookup": true
    }
}

Modify Settings

The modify settings command is used to modify analytics settings, such as data retention values and the hostname lookup policy.

Example Request:

PUT /api/analytics/v1/settings HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Content-Type: application/json
Content-Length: 60

{"retain_hour_data":600, "retain_minute_data":400, "retain_second_data":200, "hostname_lookup":true}

Example Results:

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 101
X-Zfssa-Analytics-Api: 1.0

{
    "settings": {
        "href": "/api/analytics/v1/settings",
        "retain_hour_data": 600,
        "retain_minute_data": 400,
        "retain_second_data": 200,
        "hostname_lookup": true
    }
}