Analytics API properties
This page describes API properties that you can use in API requests for DNS analytics.
A metric is a numerical value based on an attribute of the data, for example a query count.
In API requests, metrics are set in the
metrics parameter. If you need to list multiple metrics, separate them with commas.
|uncachedCount||Uncached query count||Count|
|staleCount||Stale query count||Count|
|responseTimeAvg||Average response time||Time in milliseconds|
|responseTimeMedian||Median response time||Time in milliseconds|
|responseTime90th||90th percentile response time||Time in milliseconds|
|responseTime99th||99th percentile response time||Time in milliseconds|
Dimensions can be used to break down the data by given attributes.
In API requests, dimensions are set in the
dimensions parameter. If you need to list multiple dimensions, separate them with commas.
|queryType||Query Type||Types defined by IANA. Unknown types are empty.|
|responseCode||Response Code||Response codes defined by IANA. Always uppercase.|
|responseCached||Response Cached||Either |
|coloName||Colo Name||PoP code.|
|origin||Origin||Origin used to resolve the query. Empty if N/A or if the query was answered from cache.|
|dayOfWeek||Day Of Week||Break down by day of week. Monday is |
|ipVersion||IP Version||IP protocol version used (currently |
|querySizeBucket||Query Size Bucket||Query size bucket by multiples of 16.|
|responseSizeBucket||Response Size Bucket||Response size bucket by multiples of 16.|
Filters use the form
dimension operator expression, where each part corresponds to the following:
- Dimension: Specifies the dimension to filter on. For example,
- Operator: Defines the type of filter match to use. Operators are specific to dimensions.
- Expression: States the values to include or exclude from the results. Expressions use regular expression (regex) syntax.
|Equals||Return results where |
|Does not equal||Return results where |
|Greater than||Return results where a dimension is greater than |
|Less than||Return results where a dimension is less than |
|Greater than or equal to||Return results where a dimension is greater than or equal to |
|Less than or equal to||Return results where a dimension is less than or equal to |
Combine filters using
AND boolean logic:
ANDtakes precedence over
ORin all expressions.
ORoperator is defined using a comma
ORkeyword surrounded by whitespace.
ANDoperator is defined using a semicolon
ANDkeyword surrounded by whitespace.
Examples using OR
responseCode==NOERROR,responseCode==NXDOMAINindicates that response code is either
coloName==SJC OR coloName==LAXindicates queries in either
Examples using AND
responseCode==NOERROR;queryType==AAAAindicates that response code is
NOERRORand query type is
queryType==AAAA AND coloName==SJCindicates