Analytics
AnalyticsAggregates
AnalyticsAggregatesCurrents
Get current aggregated analytics
AnalyticsEventsBytimes
Get analytics by time
ModelsExpand Collapse
BytimeGetResponse { data, data_lag, max, 5 more }
Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.
query: Query { dimensions, filters, limit, 4 more }
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.
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. |
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 |
metrics?: Array<"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 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. |
Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
AnalyticsEventsSummaries
Get analytics summary
ModelsExpand Collapse
SummaryGetResponse { data, data_lag, max, 5 more }
Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.
query: Query { dimensions, filters, limit, 4 more }
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.
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. |
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 |
metrics?: Array<"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 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. |
Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.