Skip to main content

Get internet metrics

GET 
https://api.sase.paloaltonetworks.com/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
    endTimenumber

    Sample end time (Unix timestamp).

    endpointTypestring

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

    idstringrequired

    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.

    enabledboolean
    limitnumber

    page limit

    pagenumber

    page number

    sortBystring

    sort by field

    sortOrderstring

    sort order : asc, desc

    rowCountnumber

    Number of rows in a page.

    samplePeriodnumber

    Sample period in seconds.

    series object[]
  • Array [
    • availabilitynumber

    network availability, percentage

    dataTransferTimenumber

    data transfer time, microseconds

    delaynumber

    network round trip time, microseconds

    dnsLookupTimenumber

    DNS lookup, microseconds

    jitternumber

    network jitter, microseconds

    lossnumber

    packet loss, percentage

    maxDataTransferTimenumber

    maximum data transfer time, microseconds

    maxDelaynumber

    maximum network round trip time, microseconds

    maxDnsLookupTimenumber

    maximum DNS lookup, microseconds

    maxJitternumber

    maximum network jitter, microseconds

    maxLossnumber

    maximum packet loss, percentage

    maxSslHandshakeTimenumber

    maximum SSL handshake, microseconds

    maxTcpHandshakeTimenumber

    maximum TCP handshake, microseconds

    maxThroughputnumber

    maximum data throughput

    maxTimeToFirstBytenumber

    maximum time to first byte, microseconds

    maxWaitTimenumber

    maximum wait time, microseconds

    samplenumber

    sample time (Unix timestamp)

    sslHandshakeTimenumber

    SSL handshake, microseconds

    tcpHandshakeTimenumber

    TCP handshake, microseconds

    throughputnumber

    data throughput

    timeToFirstBytenumber

    time to first byte, microseconds

    totalTimenumber

    total time, microseconds

    waitTimenumber

    wait time, microseconds

  • ]
    • startTimenumber

    Sample start time (Unix timestamp).

    tenantServiceGroupstring

    Array of tenant service groups.

Authorization: http

name: Bearertype: httpscheme: bearer
curl -L 'https://pan.dev/adem/telemetry/v2/measure/internet/metric' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
Request Collapse all
Base URL
https://api.sase.paloaltonetworks.com
Auth
Parameters
— queryrequired
— queryrequired
— headerrequired
— query
— query
— query
— query
— query
— query
— query
— header
ResponseClear

Click the Send API Request button above and see the response here!