--- title: Analytics --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Spectrum](https://developers.cloudflare.com/api/python/resources/spectrum) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Analytics #### AnalyticsAggregates #### AnalyticsAggregatesCurrents ##### [Get current aggregated analytics](https://developers.cloudflare.com/api/python/resources/spectrum/subresources/analytics/subresources/aggregates/subresources/currents/methods/get) spectrum.analytics.aggregates.currents.get(CurrentGetParams\*\*kwargs) -> [CurrentGetResponse]() GET/zones/{zone\_id}/spectrum/analytics/aggregate/current ##### ModelsExpand Collapse
List\[CurrentGetResponseItem] app\_id: str Application identifier. maxLength32 Link to this property bytes\_egress: float Number of bytes sent. Link to this property bytes\_ingress: float Number of bytes received. Link to this property connections: float Number of connections. Link to this property duration\_avg: float Average duration of connections. Link to this property
[Link to this property](<#(resource)%20spectrum.analytics.aggregates.currents%20%3E%20(model)%20current_get_response%20%3E%20(schema)>) #### AnalyticsEvents ##### ModelsExpand Collapse
Literal\["event", "appID", "coloName", "ipVersion"] One of the following: "event" Link to this property "appID" Link to this property "coloName" Link to this property "ipVersion" Link to this property
[Link to this property](<#(resource)%20spectrum.analytics.events%20%3E%20(model)%20dimension%20%3E%20(schema)>) #### AnalyticsEventsBytimes ##### [Get analytics by time](https://developers.cloudflare.com/api/python/resources/spectrum/subresources/analytics/subresources/events/subresources/bytimes/methods/get) spectrum.analytics.events.bytimes.get(BytimeGetParams\*\*kwargs) -> [BytimeGetResponse]() GET/zones/{zone\_id}/spectrum/analytics/events/bytime ##### ModelsExpand Collapse
class BytimeGetResponse: …
data: List\[Data] List of columns returned by the analytics query. dimensions: Optional\[List\[str]] Link to this property
metrics: Optional\[Union\[List\[float], List\[List\[float]], null]] One of the following: List\[float] Link to this property List\[List\[float]] Link to this property
Link to this property
Link to this property data\_lag: float Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing. minimum0 Link to this property max: Dict\[str, float] Maximum result for each selected metrics across all data. Link to this property min: Dict\[str, float] Minimum result for each selected metrics across all data. Link to this property
query: Query
dimensions: Optional\[List\[Dimension]] Can be used to break down the data by given attributes. Options are: | 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. | One of the following: "event" Link to this property "appID" Link to this property "coloName" Link to this property "ipVersion" Link to this property
Link to this property filters: Optional\[str] Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: | Operator | Name | URL Encoded | | --- | --- | --- | | == | Equals | %3D%3D | | != | Does not equals | !%3D | | > | Greater Than | %3E | | < | Less Than | %3C | | >= | Greater than or equal to | %3E%3D | | <= | Less than or equal to | %3C%3D | Use the above to construct filters. Link to this property limit: Optional\[float] Limit number of returned metrics. Link to this property
metrics: Optional\[List\[Literal\["count", "bytesIngress", "bytesEgress", 4 more]]] One or more metrics to compute. Options are: | 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. | One of the following: "count" Link to this property "bytesIngress" Link to this property "bytesEgress" Link to this property "durationAvg" Link to this property "durationMedian" Link to this property "duration90th" Link to this property "duration99th" Link to this property
Link to this property since: Optional\[datetime] Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. formatdate-time Link to this property sort: Optional\[List\[str]] The sort order for the result set; sort fields must be included in metrics or dimensions. Link to this property until: Optional\[datetime] End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. formatdate-time Link to this property
Link to this property rows: float Total number of rows in the result. minimum0 Link to this property totals: Dict\[str, float] Total result for each selected metrics across all data. Link to this property time\_intervals: Optional\[List\[List\[datetime]]] List of time interval buckets: \[start, end]. Link to this property
[Link to this property](<#(resource)%20spectrum.analytics.events.bytimes%20%3E%20(model)%20bytime_get_response%20%3E%20(schema)>) #### AnalyticsEventsSummaries ##### [Get analytics summary](https://developers.cloudflare.com/api/python/resources/spectrum/subresources/analytics/subresources/events/subresources/summaries/methods/get) spectrum.analytics.events.summaries.get(SummaryGetParams\*\*kwargs) -> [SummaryGetResponse]() GET/zones/{zone\_id}/spectrum/analytics/events/summary ##### ModelsExpand Collapse
class SummaryGetResponse: …
data: List\[Data] List of columns returned by the analytics query. dimensions: Optional\[List\[str]] Link to this property
metrics: Optional\[Union\[List\[float], List\[List\[float]], null]] One of the following: List\[float] Link to this property List\[List\[float]] Link to this property
Link to this property
Link to this property data\_lag: float Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing. minimum0 Link to this property max: Dict\[str, float] Maximum result for each selected metrics across all data. Link to this property min: Dict\[str, float] Minimum result for each selected metrics across all data. Link to this property
query: Query
dimensions: Optional\[List\[Dimension]] Can be used to break down the data by given attributes. Options are: | 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. | One of the following: "event" Link to this property "appID" Link to this property "coloName" Link to this property "ipVersion" Link to this property
Link to this property filters: Optional\[str] Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: | Operator | Name | URL Encoded | | --- | --- | --- | | == | Equals | %3D%3D | | != | Does not equals | !%3D | | > | Greater Than | %3E | | < | Less Than | %3C | | >= | Greater than or equal to | %3E%3D | | <= | Less than or equal to | %3C%3D | Use the above to construct filters. Link to this property limit: Optional\[float] Limit number of returned metrics. Link to this property
metrics: Optional\[List\[Literal\["count", "bytesIngress", "bytesEgress", 4 more]]] One or more metrics to compute. Options are: | 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. | One of the following: "count" Link to this property "bytesIngress" Link to this property "bytesEgress" Link to this property "durationAvg" Link to this property "durationMedian" Link to this property "duration90th" Link to this property "duration99th" Link to this property
Link to this property since: Optional\[datetime] Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. formatdate-time Link to this property sort: Optional\[List\[str]] The sort order for the result set; sort fields must be included in metrics or dimensions. Link to this property until: Optional\[datetime] End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. formatdate-time Link to this property
Link to this property rows: float Total number of rows in the result. minimum0 Link to this property totals: Dict\[str, float] Total result for each selected metrics across all data. Link to this property time\_intervals: Optional\[List\[List\[datetime]]] List of time interval buckets: \[start, end]. Link to this property
[Link to this property](<#(resource)%20spectrum.analytics.events.summaries%20%3E%20(model)%20summary_get_response%20%3E%20(schema)>)