Skip to main content

Get internet metrics

GET 
/adem/telemetry/v2/measure/internet/metric

Retrieves Internet metrics for Mobile Users or Remote Networks - for example delay, jitter, loss - across a specified timerange

Request​

Query Parameters

    start int64

    Possible values: <= 2147483648

    The start time of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646252520

    end int64

    Possible values: <= 2147483648

    The end time of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646263320

    timerange string

    Timerange over which you want to retrieve metrics, provided in readable format:

    last__<minute|hour|day|week|month>

    The responses are aggregated over a sample period which is a function of the time interval requested, such that the granularity decreases with increasing interval. See About Autonomous DEM API Timerange Parameter for details.

    truncate-timerange boolean

    Default value: true

    filter string

    Selects which fields to include in the query. Must use the format fieldvalue.
    The following operators are supported: >=, <=, ==, !=, >, < See About Autonomous DEM API Filter Parameter for details.

    endpoint-type stringrequired

    Possible values: [muAgent, muProbe, rnAgent, rnProbe]

    Selects the endpoint type. See About Autonomous DEM API Endpoint-type Parameter for details.

    response-type stringrequired

    Possible values: [timeseries, summary, grouped-timeseries, grouped-summary]

    group string

    The entity by which to group the results. You can use entities such as endpoint, location, site, user, or test. You can specify multiple groups as a comma-separated list. For example, group=Entity.user, group=Entity.test,Entity.location

    pagination string

    Use this parameter when the queries return a large number of results to limit the number of results in the response. See About Autonomous DEM API Pagination Parameter for details.

Header Parameters

    Prisma-Tenant stringrequired

    Used to specify a specific tenant.

    Prisma-SubTenant string

    This is an optional parameter. Specifies a sub-tenant of the Prisma-Tenant, if any.

Responses​

Internet test metrics

Schema
    oneOf
    endTime number

    Sample end time (Unix timestamp).

    endpointType string

    Endpoint type : Can have one of these values: muAgent, muProbe, rnAgent, rnProbe.

    id stringrequired

    Site ID. Required field when querying for Remote Networks-related data.

    pagination object

    Use this parameter to paginate results when the queries return a large number of results.

    enabled boolean
    limit number

    page limit

    page number

    page number

    sortBy string

    sort by field

    sortOrder string

    sort order : asc, desc

    rowCount number

    Number of rows in a page.

    samplePeriod number

    Sample period in seconds.

    series object[]
  • Array [
    • availability number

    network availability, percentage

    dataTransferTime number

    data transfer time, microseconds

    delay number

    network round trip time, microseconds

    dnsLookupTime number

    DNS lookup, microseconds

    jitter number

    network jitter, microseconds

    loss number

    packet loss, percentage

    maxDataTransferTime number

    maximum data transfer time, microseconds

    maxDelay number

    maximum network round trip time, microseconds

    maxDnsLookupTime number

    maximum DNS lookup, microseconds

    maxJitter number

    maximum network jitter, microseconds

    maxLoss number

    maximum packet loss, percentage

    maxSslHandshakeTime number

    maximum SSL handshake, microseconds

    maxTcpHandshakeTime number

    maximum TCP handshake, microseconds

    maxThroughput number

    maximum data throughput

    maxTimeToFirstByte number

    maximum time to first byte, microseconds

    maxWaitTime number

    maximum wait time, microseconds

    sample number

    sample time (Unix timestamp)

    sslHandshakeTime number

    SSL handshake, microseconds

    tcpHandshakeTime number

    TCP handshake, microseconds

    throughput number

    data throughput

    timeToFirstByte number

    time to first byte, microseconds

    totalTime number

    total time, microseconds

    waitTime number

    wait time, microseconds

  • ]
    • startTime number

    Sample start time (Unix timestamp).

    tenantServiceGroup string

    Array of tenant service groups.

Loading...