| [ Web Proxy ] |
| Viewing: https://developers.cloudflare.com/spectrum/reference/analytics/ | [Back] [Original] |
Cloudflare measures the following metrics for every connection.
| Metric | Name | Example | Unit |
|---|---|---|---|
| count | Count of total events | 1000 |
Count |
| bytesIngress | Sum of ingress bytes | 1000 |
Sum |
| bytesEgress | Sum of egress bytes | 1000 |
Sum |
| durationAvg | Average connection duration | 1.0 |
Time in milliseconds |
| durationMedian | Median connection duration | 1.0 |
Time in milliseconds |
| duration90th | 90th percentile connection duration | 1.0 |
Time in milliseconds |
| duration99th | 99th percentile connection duration | 1.0 |
Time in milliseconds |
You can divide your analytics further by the following dimensions.
| Dimension | Name | Example |
|---|---|---|
| event | Connection Event | connect, progress, disconnect, originError, clientFiltered |
| appID | Application ID | 40d67c87c6cd4b889a4fd57805225e85 |
| coloName | Colo Name | SFO |
| ipVersion | IP version used by the client | 4, 6 |
Use the operators below to filter data.
| Operator | Name | URL Encoded |
|---|---|---|
== |
Equals | %3D%3D |
!= |
Does not equal | !%3D |
> |
Greater Than | %3E |
< |
Less Than | %3C |
>= |
Greater than or equal to | %3E%3D |
<= |
Less than or equal to | %3C%3D |
Combine filters using OR and AND boolean logic:
AND takes precedence over OR in all expressions.
The OR operator is defined using a comma , or the OR keyword surrounded by whitespace.
The AND operator is defined using a semicolon ; or the AND keyword surrounded by whitespace.
Note
Note that the semicolon is a reserved character in URLs (RFC 1738 ) and should be percent-encoded as %3B.
/api/v4/zones/{zone_id}/spectrum/analytics/events/summary?metrics=METRICS&dimensions=DIMENSIONS&filters=FILTERS&since=FROM_TS&sort=SORT&until=TO_TS&limit=LIMIT
/api/v4/zones/{zone_id}/spectrum/analytics/events/bytime?metrics=METRICS&dimensions=DIMENSIONS&filters=FILTERS&since=FROM_TS&sort=SORT&until=TO_TS&limit=LIMIT
Required API token permissions
At least one of the following token permissions is required:Analytics Readcurl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/spectrum/analytics/events/summary" \
--request GET \
--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
Refer to the Spectrum API documentation for more examples of API requests.
| Web Proxy Viewer | New URL | Original Page |