Analytics

AnalyticsAggregates

AnalyticsAggregatesCurrents

Get current aggregated analytics

spectrum.analytics.aggregates.currents.get() -> CurrentGetResponse

GET/zones/{zone_id}/spectrum/analytics/aggregate/current

ModelsExpand Collapse

List[CurrentGetResponseItem]

app_id: str

Application identifier.

maxLength32

bytes_egress: float

Number of bytes sent

bytes_ingress: float

Number of bytes received

connections: float

Number of connections

duration_avg: float

Average duration of connections

AnalyticsEvents

ModelsExpand Collapse

Literal["event", "appID", "coloName", "ipVersion"]

One of the following:

"event"

"appID"

"coloName"

"ipVersion"

AnalyticsEventsBytimes

Get analytics by time

spectrum.analytics.events.bytimes.get() -> 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]]

metrics: Optional[Union[List[float], List[List[float]], null]]

One of the following:

List[float]

List[List[float]]

data_lag: float

Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.

minimum0

max: Dict[str, float]

Maximum result for each selected metrics across all data.

min: Dict[str, float]

Minimum result for each selected metrics across all data.

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"

"appID"

"coloName"

"ipVersion"

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

limit: Optional[float]

Limit number of returned metrics.

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"

"bytesIngress"

"bytesEgress"

"durationAvg"

"durationMedian"

"duration90th"

"duration99th"

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

sort: Optional[List[str]]

The sort order for the result set; sort fields must be included in metrics or dimensions.

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

rows: float

Total number of rows in the result.

minimum0

totals: Dict[str, float]

Total result for each selected metrics across all data.

time_intervals: Optional[List[List[datetime]]]

List of time interval buckets: [start, end]

AnalyticsEventsSummaries

Get analytics summary

spectrum.analytics.events.summaries.get() -> 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]]

metrics: Optional[Union[List[float], List[List[float]], null]]

One of the following:

List[float]

List[List[float]]

data_lag: float

Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.

minimum0

max: Dict[str, float]

Maximum result for each selected metrics across all data.

min: Dict[str, float]

Minimum result for each selected metrics across all data.

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"

"appID"

"coloName"

"ipVersion"

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

limit: Optional[float]

Limit number of returned metrics.

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"

"bytesIngress"

"bytesEgress"

"durationAvg"

"durationMedian"

"duration90th"

"duration99th"

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

sort: Optional[List[str]]

The sort order for the result set; sort fields must be included in metrics or dimensions.

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

rows: float

Total number of rows in the result.

minimum0

totals: Dict[str, float]

Total result for each selected metrics across all data.

time_intervals: Optional[List[List[datetime]]]

List of time interval buckets: [start, end]