diff --git a/products/access/docs/adem/adem-faqs.md b/products/access/docs/adem/adem-faqs.md new file mode 100644 index 000000000..d3b57ab99 --- /dev/null +++ b/products/access/docs/adem/adem-faqs.md @@ -0,0 +1,154 @@ +--- +id: adem-faqs +title: Autonomous DEM API FAQs +description: Autonomous DEM API FAQs +sidebar_label: ADEM API FAQs +--- + +## What are ADEM APIs used for? + +This API provides access to Autonomous Digital Experience Management summary, distribution and +timeseries data.It helps fetch data such as application score and Agent scores to help troubleshoot +if the issue is with the endpoint /application or the network. ADEM APIs can be additionally used to +fetch the zoom meeting data. + + For more information, see [Autonomous DEM API](/access/docs/adem/). + +## What type of authorization do ADEM APIs use? + +ADEM APIs are routed through the API GW which uses the OAuth2 authentication. A valid Bearer token +is required, which verifies tenant access described by the following header formats: + +| Prisma-Tenant | Prisma-SubTenant | +| --------------- | ------------------ | +| tenant_service_group | Mobile User Agent | +| : | Mobile User Probe | + + +## What are the response types that the ADEM endpoint supports? + +Each endpoint supports one or more of the following responses, specified by the response-type query +parameter: + +| response-type | Description | +| --------------- | ------------ | +| summary | A summary (aggregate) of the requested object (for example, agent or application score) | +| timeseries | A timeseries of the requested object, with the each sample an aggregate over a sample period defined by the selected time interval | +| distribution | A distribution of objects, grouped by an entity and classified into good, fair, poor categories, for example, distribution of agent scores by user or endpoint | +| grouped-summary | As for summary, grouped by one or more entities, for example, agent scores grouped by user or endpoint | +| grouped-timeseries | As for timeseries, grouped by one or more entities | +| grouped-distribution | As for distribution, grouped by one or more entities | + +For more information, see [ADEM Response Type Parameter](/access/docs/adem/response-type-parameter/). + +## What are Groups used for? + +Group parameter is used when the response-type is grouped-summary to specify which entity to group +by. The format is `Entity.[,...]`. + +For example, `Entity.user, Entity.endpoint` would group +results by user and endpoint. `en` is an alias for Entity so `en.user, en.endpoint` is also valid. + +## What are Filters used for? + + +A parameter of the form `` is used to filter the ADEM query. The following operators are supported: + +`>=`
`<=`
`==`
`!=`
`>`
`<` + +Multiple filters are supported. They can be logically combined with semi-colon to describe AND and a +comma for OR. For example, + + agent_uuid==1234,agent_uuid==5678;application==Gmail,application==Zoom + +would select records when the agent uuid is either 1234 OR 5678 AND the application is Gmail OR Zoom. + +For more information, see [ADEM Filter Parameter](/access/docs/adem/filter-parameter/). + + +## What is an include parameter? + +The include parameter is used to include additional results in the response - multiple includes can +be specified by comma separating. The format for this parameter is `.[,..]` + +| include | Alias | Description | Example | +| --------------- | ----- | ----------- | -------- | +| EntityCounts | ec | include a count of given entities | EntityCounts.user, ec.user, ec.endpoint | +| AgentProperties | ap | include agent properties | ap.ComputerName | + +For more information, see [ADEM Include Parameter](/access/docs/adem/include-parameter/). + +## What are endpoint types? + +The endpoint device is used to specify the source of the ADEM timeseries data. + +| Name | Description | +| ----- | ------------ | +| muAgent | Mobile User Agent | +| muProbe | Mobile User Probe | +| rnAgent | Remote Network Agent | +| rnProbe | Remote Network Probe | + +For more information, see [ADEM Endpoint Type Parameter](/access/docs/adem/endpoint-type-parameter/). + + +## What is a result filter? + +A result filter is used to limit results by filtering the output of the query, and maps to a HAVING +statement ( as compared with the input, which maps to a SELECT ). The output is filtered by +requiring specified scores to be in a range defined by the score classification: + +| Category | Range | +| -------- | ----- | +| poor | less than 30 | +| fair | 30 → 70 | +| good | greater than 70 | + + +| Name | Format | Type | Description | Examples | +| ----- | ------ | ---- | ----------- | -------- | +| result-filter | Score.==,..; | string | Limit score results by category | Score.endpointScore==fair,good Score.application==good;Score.lan==fair,good | + +For more information, see [ADEM Result Filter Parameter](/access/docs/adem/result-filter-parameter/). + + +## What are the valid values that can be used in a time series filter? + +- start, end : timestamps in Unix timestamp format (seconds), for example, start=1686814360&end=1686900760 +- timerange: + + | Format | Description | Example | + | ------ | ----------- | -------- | + | start,end | timestamps in Unix timestamp format (seconds) | start=1686814360&end=1686900760 | + | timerange | human readable format:

last_\_minutes \| hours \| days \| weeks \| months

| last_30\_days
last_30\_minutes
last_2\_weeks | + +For timeseries responses, records are aggregated over a sample period which is a function of the +time interval requested, such that the granularity decreases with increasing interval. This keeps +the number of sample returned to a reasonable number whilst still allowing higher resolution at +small intervals. + + | interval (days) | sample period (minutes) | + | --------------- | ----------------------- | + | <= 1 | 5 | + | <= 3 | 15 | + | <= 7 | 30 | + | <= 14 | 60 | + | <= 21 | 120 | + | > 21 | 180 | + + +## Is pagination supported? + +Yes, pagination is supported for ADEM APIs. The following are the details of pagination or sorting parameters. +A parameter used to limit the number of results in the response, used when the response type is grouped-summary + +| Name | Format | Type | Examples | +| ---- | ------ | ----- | -------- | +| pagination | page==;limit==
[;sortBy==;sortOrder==asc]
\| none | string |

page==0;limit==10;sortBy==application;
sortOrder==asc

page==0;limit==20

none | + +where page and limit are required and are the page number and number of results per page. sortBy / sortOrder are optional +If no pagination is specified, the default is page==0;limit=50. To disable paging, use pagination=none. + +For more information, see [ADEM Pagination Parameter](/access/docs/adem/pagination-parameter/). + + diff --git a/products/access/docs/adem/examples/application-performance/mu-experience-score-for-an-app.md b/products/access/docs/adem/examples/application-performance/mu-experience-score-for-an-app.md new file mode 100644 index 000000000..87a96b363 --- /dev/null +++ b/products/access/docs/adem/examples/application-performance/mu-experience-score-for-an-app.md @@ -0,0 +1,37 @@ +--- +id: mu-experience-score-for-an-app +title: Get Mobile User Experience Score for an Application +description: GET Mobile User Experience Score for an Application +sidebar_label: Get Mobile User Experience Score for an Application +--- + +This API retrieves the Mobile User experience score for an application based on its app ID. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. +The attached screen is located in Monitor -> Users -> User details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3765-mu-experience-score-for-an-app.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/application/score?timerange=last_3_day&filter=testUuid==3100bb11-dde4-4ab9-8503-d0c6ad5f9698&endpoint-type=muAgent&response-type=summary + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1692100200, +     "endTime": 1692111000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +         ":” +     ], +     "rowCount": 462, +     "average": { +         "application": 90 <<<<<< +     } + } + diff --git a/products/access/docs/adem/examples/application-performance/network-performance-metrics-for-an-application.md b/products/access/docs/adem/examples/application-performance/network-performance-metrics-for-an-application.md new file mode 100644 index 000000000..2c59039ff --- /dev/null +++ b/products/access/docs/adem/examples/application-performance/network-performance-metrics-for-an-application.md @@ -0,0 +1,59 @@ +--- +id: network-performance-metrics-for-an-application +title: Get Network Performance Metrics for an Application +description: Network Performance Metrics for a given application +sidebar_label: Get Network Performance Metrics for an Application +--- + +This API retrieves the Network Performance Metrics for a given application. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. +The attached screen is located in Monitor -> Applications -> Application details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3771-network-performance-metircs-for-an-app.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com//adem/telemetry/v2/measure/internet/metric? timerange=last_30_day&filter=testUuid==3100bb11-dde4-4ab9-8503-d0c6ad5f9698&endpoint-type=muAgent&response-type=timeseries + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691010000, +     "endTime": 1693602000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +          ":” +     ], +     "samplePeriod": 10800, +     "series": [ +         { +             "_rowCount": 352, +             "availability": 99.9, <<<<<< +             "delay": 51399, <<<<<< +             "maxDelay": 485085, +             "jitter": 17979.7, <<<<<< +             "maxJitter": 1005062, +             "loss": 0.2, <<<<<< +             "maxLoss": 60, +             "sample": 1691010000 +         }, +         { +             "_rowCount": 322, +             "availability": 100, +             "delay": 53642.5, +             "maxDelay": 477375, +             "jitter": 13411.3, +             "maxJitter": 851835, +             "loss": 0.1, +             "maxLoss": 14.3, +             "sample": 1691020800 +         }, + ……. + ] + } + diff --git a/products/access/docs/adem/examples/application-performance/timeseries-data-of-application-performance-for-all-applications.md b/products/access/docs/adem/examples/application-performance/timeseries-data-of-application-performance-for-all-applications.md new file mode 100644 index 000000000..917d00a23 --- /dev/null +++ b/products/access/docs/adem/examples/application-performance/timeseries-data-of-application-performance-for-all-applications.md @@ -0,0 +1,57 @@ +--- +id: timeseries-data-of-application-performance-for-all-applications +title: Get Timeseries Data of Application Performance for all Applications +description: Timeseries Data of Application Performance for all Applications +sidebar_label: Get Timeseries Data of Application Performance for all Applications +--- + +This API retrieves the timeseries data of application performance for all applications. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. The values shown for each field, for example dnsLookupTime, are the average values for that field in the timeseries. The availability is always 100% which is indicated by 1. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3762-timeseries-data-of-app-perf-for-all-apps.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com//adem/telemetry/v2/measure/application/metric? timerange=last_30_day&endpoint-type=muAgent&response-type=timeseries + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691334000, +     "endTime": 1693926000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +         "xxx:xxx" +     ], +     "samplePeriod": 10800, +     "series": [ +         { +             "_rowCount": 3580, +             "dnsLookupTime": 42.8, <<<<<< +             "maxDnsLookupTime": 530, +             "throughput": 3316902.9, +             "maxThroughput": 75128344, +             "tcpHandshakeTime": 82406.2, +             "maxTcpHandshakeTime": 1521664, +             "sslHandshakeTime": 197720.8, +             "maxSslHandshakeTime": 10583855, +             "waitTime": 245688.1, +             "maxWaitTime": 13142609, +             "dataTransferTime": 264332, +             "maxDataTransferTime": 15013933, +             "timeToFirstByte": 525857.4, <<<<<< +             "maxTimeToFirstByte": 13879987, +             "totalTime": 828298.6, +             "wireSize": 65611.4, +             "availability": 1, <<<<<< +             "sample": 1691334000 +         }, + ….. + ] + } + diff --git a/products/access/docs/adem/examples/application-test/application-testuuid.md b/products/access/docs/adem/examples/application-test/application-testuuid.md new file mode 100644 index 000000000..e87db635b --- /dev/null +++ b/products/access/docs/adem/examples/application-test/application-testuuid.md @@ -0,0 +1,47 @@ +--- +id: application-testuuid +title: Get an Application’s testUUID +description: Get an Application’s testUUID +sidebar_label: Get an Application’s testUUID +--- + +This API retrieves an application’s test UUID. This API does not have an impact on the UI as it only fetches the test ID and name. + +## Request + + GET https://api.sase.paloaltonetworks.com//adem/telemetry/v2/measure/application/score?timerange=last_3_day&group=en.testName,en.test&endpoint-type=muAgent&response-type=grouped-summary + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1693344600, +     "endTime": 1693603800, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +           ":” +     ], +     "pagination": { +         "page": 0, +         "limit": 50, +         "sortOrder": "DESC", +         "enabled": true +     }, +     "collection": [ +      …… +         { +             "rowCount": 13166, +             "id": { +                 "test": "", <<<<<< +                 "testName": "Google" <<<<<< +             }, +             "average": { +                 "application": 91.6 +             } +         }, +     …….. +     ] + } + diff --git a/products/access/docs/adem/examples/application-test/distribution-for-an-app-test-per-segment.md b/products/access/docs/adem/examples/application-test/distribution-for-an-app-test-per-segment.md new file mode 100644 index 000000000..53d2075ff --- /dev/null +++ b/products/access/docs/adem/examples/application-test/distribution-for-an-app-test-per-segment.md @@ -0,0 +1,80 @@ +--- +id: distribution-for-an-app-test-per-segment +title: Get Distribution for an Application Test Per Segment +description: Fetch the distribution for a particular application test per segment +sidebar_label: Get Distribution for an Application Test Per Segment +--- + +This API retrieves the distribution for a particular application test within a segment. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. +The attached screen is located in Monitor -> Applications -> Application details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3768-distribution-for-an-app-test-per-segment.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_day&filter=testUuid==3100bb11-dde4-4ab9-8503-d0c6ad5f9698&endpoint-type=muAgent&response-type=distribution + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691010000, +     "endTime": 1693602000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +            ":”    ], +     "classifier": "poor:[0 - 30],fair:[30 - 70],good:[70 - 100]", +     "entityCounts": {}, +     "collection": [ +         { +              ….. +              +         }, +         { +             "id": "wlan", +             "distribution": { +                 "clients": 5, +                 "score": 87, +                 "poor": 0, +                 "fair": 0, +                 "good": 5 +             } +         }, +       { +             "id": "lan", <<<<< +             "distribution": { +                 "clients": 17, +                 "score": 82,   <<<<<< lan segment green indicating a good score +                 "poor": 0, +                 "fair": 6, +                 "good": 11 +             } +         }, …….. +         { +             "id": "application", <<<<<< +             "distribution": { +                 "clients": 22, +                 "score": 90,  <<<<<< google base app segment green indicating a good score +                 "poor": 0, +                 "fair": 3, +                 "good": 19 +             } +         }, +         { +             "id": "internet", +             "distribution": { +                 "clients": 22, +                 "score": 92, <<<<<< internet segment green indicating a good score +                 "poor": 0, +                 "fair": 2, +                 "good": 20 +             } +         } +   ] + } + diff --git a/products/access/docs/adem/examples/application-test/distribution-for-an-application-test.md b/products/access/docs/adem/examples/application-test/distribution-for-an-application-test.md new file mode 100644 index 000000000..f4cbb4d27 --- /dev/null +++ b/products/access/docs/adem/examples/application-test/distribution-for-an-application-test.md @@ -0,0 +1,55 @@ +--- +id: distribution-for-an-application-test +title: Get the Distribution for an Application Test (Summary) +description: Fetching the distribution for a particular application test (summary) +sidebar_label: Get the Distribution for an Application Test (Summary) +--- + +This API retrieves the distribution for a particular application test. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3767-distribution-for-an-app-test.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_day&filter=testUuid==3100bb11-dde4-4ab9-8503-d0c6ad5f9698&endpoint-type=muAgent&response-type=distribution + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691010000, +     "endTime": 1693602000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +            ":”    ], +     "classifier": "poor:[0 - 30],fair:[30 - 70],good:[70 - 100]", +     "entityCounts": {}, +     "collection": [ <<<<<< +         { +             "id": "endpointScore", <<<<<< +             "distribution": { +                 "clients": 16, <<<<<< +                 "score": 90, <<<<<< +                 "poor": 0, <<<<<< +                 "fair": 2, <<<<<< +                 "good": 14 <<<<<< +             } +         }, +         { +             "id": "wlan", +             "distribution": { +                 "clients": 5, +                 "score": 87, +                 "poor": 0, +                 "fair": 0, +                 "good": 5 +             } +         }, + ….    ] + } + diff --git a/products/access/docs/adem/examples/application-test/global-distribution-of-app-score-for-an-app-test.md b/products/access/docs/adem/examples/application-test/global-distribution-of-app-score-for-an-app-test.md new file mode 100644 index 000000000..e4a9fb679 --- /dev/null +++ b/products/access/docs/adem/examples/application-test/global-distribution-of-app-score-for-an-app-test.md @@ -0,0 +1,83 @@ +--- +id: global-distribution-of-app-score-for-an-app-test +title: Get Global Distribution of App Score for an Application Test +description: Global distribution of App score for a given application test +sidebar_label: Get Global Distribution of App Score for an Application Test +--- + +This API retrieves the global distribution of application scores for a given application test. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3769-global-distribution-of-app-score-for-an-app-test.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com//adem/telemetry/v2/measure/application/score?timerange=last_30_day&filter=testUuid==3100bb11-dde4-4ab9-8503-d0c6ad5f9698&include=ec.test,ec.endpoint&endpoint-type=muAgent&response-type=grouped-summary&group=en.location + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691010000, +     "endTime": 1693602000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +            ":” +     ], +     "pagination": { +         "page": 0, +         "limit": 50, +         "sortOrder": "DESC", +         "enabled": true +     }, +     "collection": [ +         { +             "rowCount": 9389, +             "id": { +                 "location": "Australia Southeast" <<<<<< +             }, +             "average": { +                 "application": 82.8 <<<<<< +             }, +             "entityCounts": { +                 "endpoint": 4, <<<<<< +                 "location": "Australia Southeast", +                 "test": 1 <<<<<< +             } +         }, +       +         { +             "rowCount": 40616, +             "id": { +                 "location": "US West" +             }, +             "average": { +                 "application": 93.1 <<<<<< +             }, +             "entityCounts": { +                 "endpoint": 9, <<<<<< +                 "location": "US West", <<<<<< +                 "test": 1 <<<<<< +             } +         }, …….. +         { +             "rowCount": 14089, +             "id": { +                 "location": "UK" +             }, +             "average": { +                 "application": 96.6 <<<<<< +             }, +             "entityCounts": { +                 "endpoint": 2, <<<<<< +                 "location": "UK", <<<<<< +                 "test": 1 <<<<<< +             } +         } +     ] + } + diff --git a/products/access/docs/adem/examples/application-test/network-performance-metrics.md b/products/access/docs/adem/examples/application-test/network-performance-metrics.md new file mode 100644 index 000000000..f56b85554 --- /dev/null +++ b/products/access/docs/adem/examples/application-test/network-performance-metrics.md @@ -0,0 +1,56 @@ +--- +id: network-performance-metrics +title: Get Network Performance Metrics +description: Network Performance Metrics +sidebar_label: Get Network Performance Metrics +--- + +This API retrieves the Network Performance Metrics. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. The values shown in the response are the starting values shown in the graph for the first sample. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3763-network-performance-metrics.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/internet/metric?timerange=last_30_day&endpoint-type=muAgent&response-type=timeseries + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691334000, +     "endTime": 1693926000, +     "endpointType": "muAgent",tenantServiceGroup +     "tenantServiceGroup": [ +            ":"    +     ], +     "samplePeriod": 10800, +     "series": [ +         { +             "_rowCount": 3681, +             "availability": 99.5, +             "delay": 81472.1, <<<<<< +             "maxDelay": 1151403, +             "jitter": 26321.4, <<<<<< +             "maxJitter": 6596877, +             "loss": 0.6, <<<<<< +             "maxLoss": 100, +             "sample": 1691334000 +         }, +         { +             "_rowCount": 3673, +             "availability": 99.5, +             "delay": 82811.9, +             "maxDelay": 938133, +             "jitter": 26913.5, +             "maxJitter": 6826693, +             "loss": 0.6, +             "maxLoss": 100, +             "sample": 1691344800 +         },.... + ] + diff --git a/products/access/docs/adem/examples/application-test/timeseries-data-for-an-app-test.md b/products/access/docs/adem/examples/application-test/timeseries-data-for-an-app-test.md new file mode 100644 index 000000000..ada29f6b5 --- /dev/null +++ b/products/access/docs/adem/examples/application-test/timeseries-data-for-an-app-test.md @@ -0,0 +1,55 @@ +--- +id: timeseries-data-for-an-app-test +title: Get Timeseries Data for an Application Test +description: Timeseries Data for an Application Test +sidebar_label: Get Timeseries Data for an Application Test +--- + +This API retrieves the Timeseries data for a given application test. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. +The attached screen is located in Monitor -> Applications -> Application details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3766-timeseries-data-for-an-app-test.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com//adem/telemetry/v2/measure/application/score?timerange=last_30_day&filter=testUuid==3100bb11-dde4-4ab9-8503-d0c6ad5f9698&endpoint-type=muAgent&response-type=timeseries + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691010000, +     "endTime": 1693602000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +            ":”    ], +     "samplePeriod": 10800, +     "series": [ +         { +             "_rowCount": 352, +             "application": 79.3,   <<<<< beginning of the timeseries data +             "internet": 92.9, +             "sample": 1691010000 +         }, +         { +             "_rowCount": 322, +             "application": 86.5,   <<<<<<< after the app score increased for the first time +             "internet": 93.1, +             "sample": 1691020800 +         }, +          ……… +         { +             "_rowCount": 573, +             "application": 89.8,   <<<<<<< present app score +             "internet": 92.4, +             "sample": 1693591200 +         } +     ], +     "seriesEntityCount": [] + } + diff --git a/products/access/docs/adem/examples/application-test/timeseries-of-app-performance-metrics-for-an-app-test.md b/products/access/docs/adem/examples/application-test/timeseries-of-app-performance-metrics-for-an-app-test.md new file mode 100644 index 000000000..8f24a6a01 --- /dev/null +++ b/products/access/docs/adem/examples/application-test/timeseries-of-app-performance-metrics-for-an-app-test.md @@ -0,0 +1,56 @@ +--- +id: timeseries-of-app-performance-metrics-for-an-app-test +title: Get Timeseries of Application Performance Metrics for an Application Test +description: Timeseries of Application Performance Metrics for a particular application test +sidebar_label: Get Timeseries of Application Performance Metrics for an Application Test +--- + +This API retrieves the Timeseries of the Application Performance Metrics for a particular application test. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. The availability is 100% when it is 1. The graph shows the availability as 0.9 which is close to 1 indicating that the availability is close to 100%. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3770-timeseries-of-app-performance-metrics-for-app-test.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com//adem/telemetry/v2/measure/application/metric? timerange=last_30_day&filter=testUuid==3100bb11-dde4-4ab9-8503-d0c6ad5f9698&endpoint-type=muAgent&response-type=timeseries + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691010000, +     "endTime": 1693602000, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +           ":” +     ], +     "samplePeriod": 10800, +     "series": [ +         { +             "_rowCount": 351, +             "dnsLookupTime": 46.5, <<<<<< +             "maxDnsLookupTime": 408, +             "throughput": 767161.6, +             "maxThroughput": 2836784, +             "tcpHandshakeTime": 80556.8, +             "maxTcpHandshakeTime": 3608379, +             "sslHandshakeTime": 161810.9, +             "maxSslHandshakeTime": 8302431, +             "waitTime": 186277.4, +             "maxWaitTime": 1608543, +             "dataTransferTime": 67118.8, +             "maxDataTransferTime": 2269218, +             "timeToFirstByte": 428691.5, <<<<<< +             "maxTimeToFirstByte": 9268485, +             "totalTime": 511078.7, +             "wireSize": 18130.7, +             "availability": 0.9, <<<<<< +             "sample": 1691010000 +         },….. + ] + } + diff --git a/products/access/docs/adem/examples/application-test/top-20-applications-lowest-to-highest-experience-score.md b/products/access/docs/adem/examples/application-test/top-20-applications-lowest-to-highest-experience-score.md new file mode 100644 index 000000000..9753ec5f7 --- /dev/null +++ b/products/access/docs/adem/examples/application-test/top-20-applications-lowest-to-highest-experience-score.md @@ -0,0 +1,161 @@ +--- +id: top-20-applications-lowest-to-highest-experience-score +title: Get Top 20 Applications with Lowest to Highest Experience Score +description: Top 20 applications with lowest to highest experience score +sidebar_label: Get Top 20 Applications with Lowest to Highest Experience Score +--- + +This API retrieves the top 20 applications with lowest to highest experience score. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. For example, the Dropbox application has a score of 31, which is above 30 but less than 70. So its icon is represented in orange which indicates a fair experience score. +The attached screen is located in Monitor -> Users -> User details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3758-top-20-apps-with-lowest-to-highest-experience-score.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/application/score?timerange=last_30_days&endpoint-type=muAgent&response-type=grouped-summary&pagination=page==0;limit==500;sortBy==application;sortOrder==asc&group=en.testName,en.test + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1689627600, +     "endTime": 1692219600, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +                     ":"       ], +     "pagination": { +         "page": 0, +         "limit": 500, +         "sortBy": "application", +         "sortOrder": "ASC", +         "enabled": true +     }, +     "collection": [ +         { +             "rowCount": 1, +             "id": { +                 "test": "9114bf6b-f86d-44\u0000\u00002b-\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u00000c5e", +                 "testName": null +             }, +             "average": { +                 "application": 0 +             } +         }, +         { +             "rowCount": 23132, +             "id": { +                 "test": "", +                 "testName": "Dropbox" <<<<<< +             }, +             "average": { +                 "application": 31 <<<<<< +             } +         }, +         { +             "rowCount": 7781, +             "id": { +                 "test": "", +                 "testName": "AWS" <<<<<< +             }, +             "average": { +                 "application": 34.7 <<<<<< +             } +         }, +         { +             "rowCount": 100636, +             "id": { +                 "test": "", +                 "testName": "Zoom - PANWSASE" +             }, +             "average": { +                 "application": 77.1 +             } +         }, +         { +             "rowCount": 86717, +             "id": { +                 "test": "", +                 "testName": "MS Teams" +             }, +             "average": { +                 "application": 83.9 +             } +         }, +         { +             "rowCount": 100597, +             "id": { +                 "test": "", +                 "testName": "Webex" +             }, +             "average": { +                 "application": 84.1 +             } +         }, +         { +             "rowCount": 27348, +             "id": { +                 "test": "", +                 "testName": "SuperSaaSApp" +             }, +             "average": { +                 "application": 87.1 +             } +         }, +         { +             "rowCount": 100623, +             "id": { +                 "test": "", +                 "testName": "Google" +             }, +             "average": { +                 "application": 88.6 +             } +         }, +         { +             "rowCount": 100596, +             "id": { +                 "test": "", +                 "testName": "Slack" +             }, +             "average": { +                 "application": 89.3 +             } +         }, +         { +             "rowCount": 48693, +             "id": { +                 "test": "", +                 "testName": "Salesforce" +             }, +             "average": { +                 "application": 93.6 +             } +         }, +         { +             "rowCount": 100640, +             "id": { +                 "test": "", +                 "testName": "MS Office" +             }, +             "average": { +                 "application": 94 +             } +         }, +         { +             "rowCount": 9, +             "id": { +                 "test": "", +                 "testName": null +             }, +             "average": { +                 "application": 99.7 +             } +         } +     ] + } + diff --git a/products/access/docs/adem/examples/mobile-users/distribution-of-mu-agent-scores-by-endpoint-across-all-tests.md b/products/access/docs/adem/examples/mobile-users/distribution-of-mu-agent-scores-by-endpoint-across-all-tests.md new file mode 100644 index 000000000..27e443cc7 --- /dev/null +++ b/products/access/docs/adem/examples/mobile-users/distribution-of-mu-agent-scores-by-endpoint-across-all-tests.md @@ -0,0 +1,111 @@ +--- +id: distribution-of-mu-agent-scores-by-endpoint-across-all-tests +title: Get Distribution of Mobile User Agent Scores by Endpoint Across All Tests +description: Get a distribution of MU agent scores by endpoint (across all tests) +sidebar_label: Get Distribution of Mobile User Agent Scores by Endpoint Across All Tests +--- + +This API retrieves the distribution of monitored mobile user scores by endpoint across all application tests. The icons are represented in one of three colors, red, orange, or green, that indicate the health of the segment based on the experience score. +Red (poor) - experience score <30 +Orange (fair) - experience score >=30 but <=70 +Green (good) - experince score is >70 + +The attached screen is located in Monitor -> Applications-> Application details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3757-distribution-of-mu-agent-scores-by-endpoint.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_days&endpoint-type=muAgent&response-type=summary + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1689616800, +     "endTime": 1692208800, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +             ":"    +  ], +     "classifier": "poor:[0 - 30],fair:[30 - 70],good:[70 - 100]", +     "entityCounts": {}, +     "collection": [ +         { +             "id": "endpointScore", +             "distribution": { +                 "clients": 22, +                 "score": 96, +                 "poor": 0, +                 "fair": 0, +                 "good": 22 +             } +         }, +         { +             "id": "wlan", +             "distribution": { +                 "clients": 3, +                 "score": 85, +                 "poor": 0, +                 "fair": 0, +                 "good": 3 +             } +         }, +         { +             "id": "lan", <<<<<< +             "distribution": { +                 "clients": 17, +                 "score": 81, <<<<<< +                 "poor": 0, <<<<<< +                 "fair": 5, <<<<<< +                 "good": 12 <<<<<< +             } +         }, +         { +             "id": "vpnUnderlay", +             "distribution": { +                 "clients": 19, +                 "score": 90, +                 "poor": 0, +                 "fair": 2, +                 "good": 17 +             } +         }, +         { +             "id": "vpnOverlay", +             "distribution": { +                 "clients": 14, +                 "score": 85, +                 "poor": 0, +                 "fair": 2, +                 "good": 12 +             } +         }, +         { +             "id": "application", +             "distribution": { +                 "clients": 22, +                 "score": 81, +                 "poor": 1, +                 "fair": 3, +                 "good": 18 +             } +         }, +         { +             "id": "internet", <<<<<< +             "distribution": { +                 "clients": 22, +                 "score": 89, <<<<<< +                 "poor": 0, <<<<<< +                 "fair": 1, <<<<<< +                 "good": 21 <<<<<< +             } +         } +     ] + }} + diff --git a/products/access/docs/adem/examples/mobile-users/distribution-of-mu-application-score.md b/products/access/docs/adem/examples/mobile-users/distribution-of-mu-application-score.md new file mode 100644 index 000000000..f4d4729a1 --- /dev/null +++ b/products/access/docs/adem/examples/mobile-users/distribution-of-mu-application-score.md @@ -0,0 +1,42 @@ +--- +id: distribution-of-mu-application-score +title: Get Distribution of Mobile User Application Score +description: Distribution of Mobile User Application Score +sidebar_label: Get Distribution of Mobile User Application Score +--- + +This API retrieves the experience score distribution (Good, Fair, Poor) across all monitored Mobile User devices. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. +The attached screen is located in Monitor -> Users -> User details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3755-distribution-of-mu-app-score.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_days&endpoint-type=muAgent&response-type=summary + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1689627600, +     "endTime": 1692219600, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +         ":" +     ], +     "id": "tests", +     "classifier": "poor:[0 - 30],fair:[30 - 70],good:[70 - 100]", +     "distribution": { +         "clients": 11, +         "score": 69, +         "poor": 1,   <<<<<< Distribution of Mobile User Application Score +       "fair": 2,   <<<<<< Distribution of Mobile User Application Score +       "good": 8 <<<<<< Distribution of Mobile User Application Score +     } + } + diff --git a/products/access/docs/adem/examples/mobile-users/experience-score-for-top-monitored-mu-devices.md b/products/access/docs/adem/examples/mobile-users/experience-score-for-top-monitored-mu-devices.md new file mode 100644 index 000000000..f43dba233 --- /dev/null +++ b/products/access/docs/adem/examples/mobile-users/experience-score-for-top-monitored-mu-devices.md @@ -0,0 +1,77 @@ +--- +id: experience-score-for-top-monitored-mu-devices +title: Get Experience Score for Top Monitored Mobile User Devices +description: Experience Score for Top Monitored Mobile User Devices +sidebar_label: Get Experience Score for Top Monitored Mobile User Devices +--- + +This API retrieves the experience score for top monitored Mobile User devices. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. "endpoint" represents the device that the user is using. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3760-exp-score-for-top-monitored-mu-devices.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_days&endpoint-type=muAgent&response-type=grouped-summary&group=en.endpoint&include=ap.username + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1689692400, +     "endTime": 1692284400, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +            ":"    +     ], +     "pagination": { +         "page": 0, +         "limit": 50, +         "sortOrder": "DESC", +         "enabled": true +     }, +     "collection": [ +         { +             "rowCount": 6102, +             "id": { +                 "endpoint": "" <<<<<< +             }, +             "average": { +                 "endpointScore": 91.1, +                 "wlan": null, +                 "lan": 68.7, +                 "vpnUnderlay": null, +                 "vpnOverlay": null, +                 "application": 84.7, <<<<<< +                 "internet": 88.5 +             }, +             "agentProperties": { +                 "username": "xxxxxx@xxxxxx.com" <<<<<< +             } +         }, +         { +             "rowCount": 4753, +             "id": { +                 "endpoint": "" <<<<<< +             }, +             "average": { +                 "endpointScore": 99.4, +                 "wlan": null, +                 "lan": 73.8, +                 "vpnUnderlay": 51.5, +                 "vpnOverlay": 53.2, +                 "application": 67.9, <<<<<< +                 "internet": 75.2 +             }, +             "agentProperties": { +                 "username": "xxxxxx@xxxxxx.com" +             } +         }, +         },…… +     ] + } + diff --git a/products/access/docs/adem/examples/mobile-users/fetch-all-mu-adem-agents-logged-in-for-last-30-days.md b/products/access/docs/adem/examples/mobile-users/fetch-all-mu-adem-agents-logged-in-for-last-30-days.md new file mode 100644 index 000000000..469c6c863 --- /dev/null +++ b/products/access/docs/adem/examples/mobile-users/fetch-all-mu-adem-agents-logged-in-for-last-30-days.md @@ -0,0 +1,55 @@ +--- +id: fetch-all-mu-adem-agents-logged-in-for-last-30-days +title: Get All the Mobile User ADEM Agents Logged in for the Last 30 Days +description: Fetch all the Mobile Users ADEM agents logged in for the last 30 days +sidebar_label: Get all the Mobile Users ADEM agents logged in for the last 30 days +--- + +This API retrieves all the Mobile Users ADEM agents logged in for the last 30 days. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3761-mu-adem-agents-logged-in-the-last-30-days.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/agent/v2/measure/agent/score?timerange=last_30_days&group=en.endpoint,en.user&endpoint-type=muAgent&response-type=grouped-summary + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1687262400, +     "endTime": 1689854400, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +                   ":"       ], +     "pagination": { +         "page": 0, +         "limit": 50, +         "sortOrder": "DESC", +         "enabled": true +     }, +     "collection": [ +         { +             "rowCount": 87, +             "id": { +                 "endpoint": "", +                 "user": "xxxxxx@xxxxxx.com" <<<<<< +             }, +             "average": { +                 "endpointScore": 99.6, +                 "wlan": 84.5, +                 "lan": 62.9, +                 "vpnUnderlay": 88.2, +                 "vpnOverlay": 93.3, +                 "application": 65.2, <<<<<< Experience score for the Mobile User agent on the users device +                 "internet": 64 +             }, +             "agentProperties": {} +         }, +     ] + diff --git a/products/access/docs/adem/examples/mobile-users/global-distribution-of-application-experience-scores-for-mu-devices.md b/products/access/docs/adem/examples/mobile-users/global-distribution-of-application-experience-scores-for-mu-devices.md new file mode 100644 index 000000000..f9414031f --- /dev/null +++ b/products/access/docs/adem/examples/mobile-users/global-distribution-of-application-experience-scores-for-mu-devices.md @@ -0,0 +1,157 @@ +--- +id: global-distribution-of-application-experience-scores-for-mu-devices +title: Get Global Distribution of Application Experience Scores for Mobile User Devices +description: Global Distribution of Application Experience Scores for Mobile User Devices +sidebar_label: Get Global Distribution of Application Experience Scores for Mobile User Devices +--- + +The API retrieves the Global Distribution of application experience scores for all monitored Mobile User devices. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. The US Southeast location displays a green circle indicating that it has a good score (85.4), whereas the US Central displays an orange circle indicating a fair score (61.2). +The attached screen is located in Monitor -> Applications -> Application details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3759-global-dist-of-app-exp-scores-for-mu-devices.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/application/score/ ?timerange=last_30_days&include=ec.test,ec.endpoint-type&endpoint-type=muAgent&response-type=grouped-summary&group=en.location + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1689627600, +     "endTime": 1692219600, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +                     ":"       ], +     "pagination": { +         "page": 0, +         "limit": 50, +         "sortOrder": "DESC", +         "enabled": true +     }, +     "collection": [ +         { +             "rowCount": 46738, +             "id": { +                 "location": "US Southeast" <<<<<< +             }, +             "average": { +                 "application": 85.4 <<<<<< +             }, +             "entityCounts": { +                 "location": "US Southeast", +                 "test": 8 +             } +         }, +         { +             "rowCount": 112123, +             "id": { +                 "location": "UK" <<<<<< +             }, +             "average": { +                 "application": 94.4 <<<<<< +             }, +             "entityCounts": { +                 "location": "UK", +                 "test": 6 +             } +         }, +         { +             "rowCount": 42516, +             "id": { +                 "location": "" +             }, +             "average": { +                 "application": 70.3 +             }, +             "entityCounts": { +                 "location": "", +                 "test": 6 +             } +         }, +         { +             "rowCount": 203, +             "id": { +                 "location": "India West" +             }, +             "average": { +                 "application": 80.4 +             }, +             "entityCounts": { +                 "location": "India West", +                 "test": 6 +             } +         }, +         { +             "rowCount": 35042, +             "id": { +                 "location": null +             }, +             "average": { +                 "application": 62.5 +             }, +             "entityCounts": { +                 "location": null, +                 "test": 9 +             } +         }, +         { +             "rowCount": 146669, +             "id": { +                 "location": "US Northeast" +             }, +             "average": { +                 "application": 96.7 +             }, +             "entityCounts": { +                 "location": "US Northeast", +                 "test": 8 +             } +         }, +         { +             "rowCount": 109845, +             "id": { +                 "location": "US West" +             }, +             "average": { +                 "application": 84.8 +             }, +             "entityCounts": { +                 "location": "US West", +                 "test": 10 +             } +         }, +         { +             "rowCount": 2055, +             "id": { +                 "location": "US Central" <<<<<< +             }, +             "average": { +                 "application": 61.2.    <<<<< marked in orange in the UI +             }, +             "entityCounts": { +                 "location": "US Central", +                 "test": 7 +             } +         }, +         { +             "rowCount": 201617, +             "id": { +                 "location": "Australia Southeast" +             }, +             "average": { +                 "application": 76.4 +             }, +             "entityCounts": { +                 "location": "Australia Southeast", +                 "test": 11 +             } +         } +     ] + } + diff --git a/products/access/docs/adem/examples/mobile-users/mu-agent-score-aggregated-across-all-endpoints.md b/products/access/docs/adem/examples/mobile-users/mu-agent-score-aggregated-across-all-endpoints.md new file mode 100644 index 000000000..659a109e6 --- /dev/null +++ b/products/access/docs/adem/examples/mobile-users/mu-agent-score-aggregated-across-all-endpoints.md @@ -0,0 +1,39 @@ +--- +id: mu-agent-score-aggregated-across-all-endpoints +title: Get Mobile User Agent Score Aggregated Across All Endpoints +description: Mobile User Agent Score Aggregated Across All Endpoints +sidebar_label: Get Mobile User Agent Score Aggregated Across All Endpoints +--- + +This API retrieves the Mobile Users experience score. The score is aggregated across all the monitored mobile user devices. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. +The attached screen is located in Monitor -> Users -> User details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3754-mu-agent-score.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_days&endpoint-type=muAgent&response-type=summary + + header = { "prisma-tenant": "" } + + +## Response + + { + "startTime": 1689616800,    + "endTime": 1692208800,    + "endpointType": "muAgent",    + "tenantServiceGroup": [ ":" ],    + "rowCount": 101009,    + "average": { "endpointScore": 95.5,        + "wlan": 85.4,        + "lan": 76.5,        + "vpnUnderlay": 89.7,        + "vpnOverlay": 79.4,        + "application": 83.6,   <<<<<< Application Score for the MU agent highlighted in the screenshot        + "internet": 88.9    + } + diff --git a/products/access/docs/adem/examples/mobile-users/timeseries-of-mu-agent-scores.md b/products/access/docs/adem/examples/mobile-users/timeseries-of-mu-agent-scores.md new file mode 100644 index 000000000..2703c023a --- /dev/null +++ b/products/access/docs/adem/examples/mobile-users/timeseries-of-mu-agent-scores.md @@ -0,0 +1,71 @@ +--- +id: timeseries-of-mu-agent-scores +title: Get Timeseries of Mobile User Agent Scores +description: Timeseries of Mobile User Agent Scores +sidebar_label: Get Timeseries of Mobile User Agent Scores +--- + +This API retrieves the timeseries for the application experience score trend for all monitored mobile user devices. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the experience score recorded at the start time of the timeseries segment. In the graph shown in the screenshot, the trend line is green since the score at all times shown is over 70 which represents a good score. +The attached screen is located in Monitor -> Applications-> Application details page in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3756-timeseries-of-mu-agent-scores.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_days&endpoint-type=muAgent&response-type=timeseries + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1689627600, +     "endTime": 1692219600, +     "endpointType": "muAgent", +     "tenantServiceGroup": [ +            ":" +     ], +     "samplePeriod": 10800, +     "series": [ +         { +             "_rowCount": 288, +             "endpointScore": 95.2, +             "wlan": 86.3, +             "lan": 61.1, +             "vpnUnderlay": 83.5, +             "vpnOverlay": 73.9, +             "internet": 84.7, +             "application": 81.7, <<<<<< +             "sample": 1689627600 <<<<<< +         }, +         { +             "_rowCount": 262, +             "endpointScore": 96.6, +             "wlan": 84.5, +             "lan": 72.1, +             "vpnUnderlay": 94.6, +             "vpnOverlay": 81.4, +             "internet": 87.8, +             "application": 86, <<<<<< +             "sample": 1689638400 <<<<<< +         }, +         ….. +          { +             "_rowCount": 430, +             "endpointScore": 96.5, +             "wlan": 86.2, +             "lan": 85.1, +             "vpnUnderlay": 90.5, +             "vpnOverlay": 68.2, +             "internet": 88.9, +             "application": 84.4, <<<<<< +             "sample": 1692208800 <<<<<< +         } +     ], +     "seriesEntityCount": [] + } + diff --git a/products/access/docs/adem/examples/remote-networks/adem-apis-for-rns.md b/products/access/docs/adem/examples/remote-networks/adem-apis-for-rns.md new file mode 100644 index 000000000..85c6aad31 --- /dev/null +++ b/products/access/docs/adem/examples/remote-networks/adem-apis-for-rns.md @@ -0,0 +1,42 @@ +--- +id: adem-apis-for-rns +title: Autonomous DEM Retrieve RNs +description: Autonomous DEM Remote Networks Metrics API Example +sidebar_label: ADEM Retrieve RN Metrics +--- + +You can retrieve all the same metrics for Remote Networks as you retrieved for your Mobile Users. All the APIs for Mobile Users can be used for endpoint Remote Networks by using endpoint-type=rnAgent. In each of the Mobile User APIs replace endpoint-type=muAgent with endpoint-type=rnAgent. Remote Agent Score is aggregated across all Remote Networks + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3772-remote-agent-score-aggregated-across-all-rn.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/agent/score?timerange=last_30_days&endpoint-type=rnAgent&response-type=summary + + header = { "prisma-tenant": "" } + + +## Response + + { +     "startTime": 1691334000, +     "endTime": 1693926000, +     "endpointType": "rnAgent", +     "tenantServiceGroup": [ +          ":” +     ], +     "rowCount": 51590, +     "average": { +         "endpointScore": 67.1, +         "wlan": null, +         "lan": null, +         "vpnUnderlay": 74.5, +         "vpnOverlay": 76, +         "application": 64.2, <<<<<< +         "internet": 68.1 +     } + } + diff --git a/products/access/docs/adem/examples/zoom-data/fetch-zoom-meeting-data-for-a-user.md b/products/access/docs/adem/examples/zoom-data/fetch-zoom-meeting-data-for-a-user.md new file mode 100644 index 000000000..942c6857d --- /dev/null +++ b/products/access/docs/adem/examples/zoom-data/fetch-zoom-meeting-data-for-a-user.md @@ -0,0 +1,119 @@ +--- +id: fetch-zoom-meeting-data-for-a-user +title: Get Zoom Meeting Data for a User +description: Fetch zoom meeting data for a particular user +sidebar_label: Get Zoom Meeting Data for a User +--- + +This API retrieves zoom meeting data for a particular user. In the Response section, the lines that are followed by a comment (<<<<<<) correspond to the location in the UI (see attached screenshot) that is enclosed in a red box. +The attached screen is located in Monitor -> Users -> User details page (Zoom Performance Analysis tab) in the Strata Cloud Manager UI. + +The following shows the portions of the UI widget where the data is displayed for this example: + +![](/sase/img/adem/DOCS-3773-zoom-meeting-data-for-a-particular-user.png) + + +## Request + + GET https://api.sase.paloaltonetworks.com/adem/telemetry/v2/measure/internet/metric? timerange=last_30_day&filter=email=auntyjack@panwsase.com + + header = { "prisma-tenant": "" } + + +## Response + + [ + { +         "meetingUuid": "fa05d660556b49e7b979bb1bd2171328", +         "email": "xxxx@xxxxx.com", +         "recordId": "1f5ef19d-e890-4520-9517-cccc6bc55a2a", +         "accountId": "Oc9Dz_jJTPiiczkAOkA_RQ", +         "duration": 0, +         "startTime": "2023-08-31T02:00:09Z", +         "timezone": "Australia/Sydney", +         "topic": null, +         "meetingId": "89183316435", +         "userId": "16778240", +         "userName": "xxxxx@xxxxx.com", +         "joinTime": "2023-08-31T02:00:09Z", +         "leaveTime": "2023-08-31T02:10:01Z", +         "actualDuration": 592, +         "meetingHostId": "d6CeI4iER_qzaSNgnzVf6Q", +         "eventTimeEpoch": 1693447804010, +         "eventTime": "2023-08-31T02:10:04Z", +         "pcName": "DESKTOP-VELG4SR", +         "macAddress": "xx:xx:xx:xx:xx:xx", +         "domain": "NA", +         "harddiskId": "NA", +         "destinationIpPort": "443", +         "destinationIpDomain": "zoomsyt50mmr.sy.zoom.us", +         "dataCenter": "SY (Top)", +         "networkType": "others", +         "location": "Brisbane(AU)", +         "microphone": "Microphone (Realtek(R) Audio)", +         "signalingInternalIpAddress": "xxx.xx.xx.xx", +         "version": "5.15.7.20303", +         "device": "Windows", +         "signalingInternalIpPort": "51758", +         "asInternalIpAddress": "xxx.xx.xx.xx", +         "asInternalIpPort": "62528", +         "speaker": "Speakers (Realtek(R) Audio)", +         "videoInternalIpAddress": "xxx.xx.xx.xx", +         "videoInternalIpPort": "62523", +         "audioInternalIpPort": "62525", +         "audioInternalIpAddress": "xxx.xx.xx.xx", +         "camera": null, +         "tenantId": "1359465673", +         "subTenantId": "1359465673", +         "tenantServiceGroup": "1359465673:1359465673", +         "agentUuid": "dbf9a4d0-1ac5-436c-91a2-c44a8cdbe8f6", +         "score": 100 + }, + { +         "meetingUuid": "bda1594d8f4a40ea88cf6e6c28142378", +         "email": "xxxxx@xxxxxx.com", +         "recordId": "35991287-0dcd-40d3-a8de-abb34ca656e3", +         "accountId": "Oc9Dz_jJTPiiczkAOkA_RQ", +         "duration": 0, +         "startTime": "2023-09-04T06:00:14Z", +         "timezone": "Australia/Sydney", +         "topic": null, +         "meetingId": "81505431105", +         "userId": "16778240", +         "userName": "xxxxxx@xxxxxx.com", +         "joinTime": "2023-09-04T05:59:11Z", +         "leaveTime": "2023-09-04T06:37:30Z", +         "actualDuration": 2299, +         "meetingHostId": "d6CeI4iER_qzaSNgnzVf6Q", +         "eventTimeEpoch": 1693809515656, +         "eventTime": "2023-09-04T06:38:35Z", +         "pcName": "DESKTOP-VELG4SR", +         "macAddress": "xx:xx:xx:xx:xx:xx", +         "domain": "NA", +         "harddiskId": "NA", +         "destinationIpPort": "443", +         "destinationIpDomain": "zoommeltd100mmr.mel.zoom.us", +         "dataCenter": "MEL (Top)", +         "networkType": "others", +         "location": null, +         "microphone": "Microphone (Realtek(R) Audio)", +         "signalingInternalIpAddress": "xxx.xx.xx.xx", +         "version": "5.15.7.20303", +         "device": "Windows", +         "signalingInternalIpPort": "56024", +         "asInternalIpAddress": "xxx.xx.xx.xx", +         "asInternalIpPort": "56141", +         "speaker": "Speakers (Realtek(R) Audio)", +         "videoInternalIpAddress": "xxx.xx.xx.xx", +         "videoInternalIpPort": "56136", +         "audioInternalIpPort": "56139", +         "audioInternalIpAddress": "xxx.xx.xx.xx", +         "camera": null, +         "tenantId": "1359465673", +         "subTenantId": "1359465673", +         "tenantServiceGroup": "1359465673:1359465673", +         "agentUuid": "dbf9a4d0-1ac5-436c-91a2-c44a8cdbe8f6", +         "score": 40 +     },….. + ] + diff --git a/products/sase/sidebars.js b/products/sase/sidebars.js index 95accf23d..5d0bb876a 100644 --- a/products/sase/sidebars.js +++ b/products/sase/sidebars.js @@ -99,6 +99,7 @@ module.exports = { items: [ "access/docs/adem/adem", "access/docs/adem/getstarted", + "access/docs/adem/adem-faqs", { type: "category", label: "Parameter Details", @@ -113,6 +114,68 @@ module.exports = { "access/docs/adem/timerange-parameter", ], }, + { + type: "category", + label: "Examples", + collapsed: true, + items: [ + { + type: "category", + label: "Application Performance", + collapsed: true, + items: [ + "access/docs/adem/examples/application-performance/mu-experience-score-for-an-app", + "access/docs/adem/examples/application-performance/network-performance-metrics-for-an-application", + "access/docs/adem/examples/application-performance/timeseries-data-of-application-performance-for-all-applications", + ], + }, + { + type: "category", + label: "Application Test", + collapsed: true, + items: [ + "access/docs/adem/examples/application-test/application-testuuid", + "access/docs/adem/examples/application-test/distribution-for-an-app-test-per-segment", + "access/docs/adem/examples/application-test/distribution-for-an-application-test", + "access/docs/adem/examples/application-test/global-distribution-of-app-score-for-an-app-test", + "access/docs/adem/examples/application-test/network-performance-metrics", + "access/docs/adem/examples/application-test/timeseries-data-for-an-app-test", + "access/docs/adem/examples/application-test/timeseries-of-app-performance-metrics-for-an-app-test", + "access/docs/adem/examples/application-test/top-20-applications-lowest-to-highest-experience-score", + ], + }, + { + type: "category", + label: "Mobile Users", + collapsed: true, + items: [ + "access/docs/adem/examples/mobile-users/distribution-of-mu-agent-scores-by-endpoint-across-all-tests", + "access/docs/adem/examples/mobile-users/distribution-of-mu-application-score", + "access/docs/adem/examples/mobile-users/experience-score-for-top-monitored-mu-devices", + "access/docs/adem/examples/mobile-users/fetch-all-mu-adem-agents-logged-in-for-last-30-days", + "access/docs/adem/examples/mobile-users/global-distribution-of-application-experience-scores-for-mu-devices", + "access/docs/adem/examples/mobile-users/mu-agent-score-aggregated-across-all-endpoints", + "access/docs/adem/examples/mobile-users/timeseries-of-mu-agent-scores", + ], + }, + { + type: "category", + label: "Remote Networks", + collapsed: true, + items: [ + "access/docs/adem/examples/remote-networks/adem-apis-for-rns", + ], + }, + { + type: "category", + label: "Zoom Data", + collapsed: true, + items: [ + "access/docs/adem/examples/zoom-data/fetch-zoom-meeting-data-for-a-user", + ], + }, + ], + }, ], }, { diff --git a/static/sase/img/adem/DOCS-3754-mu-agent-score.png b/static/sase/img/adem/DOCS-3754-mu-agent-score.png new file mode 100644 index 000000000..e4544de67 Binary files /dev/null and b/static/sase/img/adem/DOCS-3754-mu-agent-score.png differ diff --git a/static/sase/img/adem/DOCS-3755-distribution-of-mu-app-score.png b/static/sase/img/adem/DOCS-3755-distribution-of-mu-app-score.png new file mode 100644 index 000000000..0573efbe7 Binary files /dev/null and b/static/sase/img/adem/DOCS-3755-distribution-of-mu-app-score.png differ diff --git a/static/sase/img/adem/DOCS-3756-timeseries-of-mu-agent-scores.png b/static/sase/img/adem/DOCS-3756-timeseries-of-mu-agent-scores.png new file mode 100644 index 000000000..98a6173b3 Binary files /dev/null and b/static/sase/img/adem/DOCS-3756-timeseries-of-mu-agent-scores.png differ diff --git a/static/sase/img/adem/DOCS-3757-distribution-of-mu-agent-scores-by-endpoint.png b/static/sase/img/adem/DOCS-3757-distribution-of-mu-agent-scores-by-endpoint.png new file mode 100644 index 000000000..0f3a94e18 Binary files /dev/null and b/static/sase/img/adem/DOCS-3757-distribution-of-mu-agent-scores-by-endpoint.png differ diff --git a/static/sase/img/adem/DOCS-3758-top-20-apps-with-lowest-to-highest-experience-score.png b/static/sase/img/adem/DOCS-3758-top-20-apps-with-lowest-to-highest-experience-score.png new file mode 100644 index 000000000..b528242d7 Binary files /dev/null and b/static/sase/img/adem/DOCS-3758-top-20-apps-with-lowest-to-highest-experience-score.png differ diff --git a/static/sase/img/adem/DOCS-3759-global-dist-of-app-exp-scores-for-mu-devices.png b/static/sase/img/adem/DOCS-3759-global-dist-of-app-exp-scores-for-mu-devices.png new file mode 100644 index 000000000..b4ab85b37 Binary files /dev/null and b/static/sase/img/adem/DOCS-3759-global-dist-of-app-exp-scores-for-mu-devices.png differ diff --git a/static/sase/img/adem/DOCS-3760-exp-score-for-top-monitored-mu-devices.png b/static/sase/img/adem/DOCS-3760-exp-score-for-top-monitored-mu-devices.png new file mode 100644 index 000000000..cbdbcfea4 Binary files /dev/null and b/static/sase/img/adem/DOCS-3760-exp-score-for-top-monitored-mu-devices.png differ diff --git a/static/sase/img/adem/DOCS-3761-mu-adem-agents-logged-in-the-last-30-days.png b/static/sase/img/adem/DOCS-3761-mu-adem-agents-logged-in-the-last-30-days.png new file mode 100644 index 000000000..33360edb2 Binary files /dev/null and b/static/sase/img/adem/DOCS-3761-mu-adem-agents-logged-in-the-last-30-days.png differ diff --git a/static/sase/img/adem/DOCS-3762-timeseries-data-of-app-perf-for-all-apps.png b/static/sase/img/adem/DOCS-3762-timeseries-data-of-app-perf-for-all-apps.png new file mode 100644 index 000000000..ec6729216 Binary files /dev/null and b/static/sase/img/adem/DOCS-3762-timeseries-data-of-app-perf-for-all-apps.png differ diff --git a/static/sase/img/adem/DOCS-3763-network-performance-metrics.png b/static/sase/img/adem/DOCS-3763-network-performance-metrics.png new file mode 100644 index 000000000..f1ae0980b Binary files /dev/null and b/static/sase/img/adem/DOCS-3763-network-performance-metrics.png differ diff --git a/static/sase/img/adem/DOCS-3765-mu-experience-score-for-an-app.png b/static/sase/img/adem/DOCS-3765-mu-experience-score-for-an-app.png new file mode 100644 index 000000000..89d797bc0 Binary files /dev/null and b/static/sase/img/adem/DOCS-3765-mu-experience-score-for-an-app.png differ diff --git a/static/sase/img/adem/DOCS-3766-timeseries-data-for-an-app-test.png b/static/sase/img/adem/DOCS-3766-timeseries-data-for-an-app-test.png new file mode 100644 index 000000000..66a5507bc Binary files /dev/null and b/static/sase/img/adem/DOCS-3766-timeseries-data-for-an-app-test.png differ diff --git a/static/sase/img/adem/DOCS-3767-distribution-for-an-app-test.png b/static/sase/img/adem/DOCS-3767-distribution-for-an-app-test.png new file mode 100644 index 000000000..6c5eababf Binary files /dev/null and b/static/sase/img/adem/DOCS-3767-distribution-for-an-app-test.png differ diff --git a/static/sase/img/adem/DOCS-3768-distribution-for-an-app-test-per-segment.png b/static/sase/img/adem/DOCS-3768-distribution-for-an-app-test-per-segment.png new file mode 100644 index 000000000..ae8ab8dbd Binary files /dev/null and b/static/sase/img/adem/DOCS-3768-distribution-for-an-app-test-per-segment.png differ diff --git a/static/sase/img/adem/DOCS-3769-global-distribution-of-app-score-for-an-app-test.png b/static/sase/img/adem/DOCS-3769-global-distribution-of-app-score-for-an-app-test.png new file mode 100644 index 000000000..eeb3cccba Binary files /dev/null and b/static/sase/img/adem/DOCS-3769-global-distribution-of-app-score-for-an-app-test.png differ diff --git a/static/sase/img/adem/DOCS-3770-timeseries-of-app-performance-metrics-for-app-test.png b/static/sase/img/adem/DOCS-3770-timeseries-of-app-performance-metrics-for-app-test.png new file mode 100644 index 000000000..5a81bc0f1 Binary files /dev/null and b/static/sase/img/adem/DOCS-3770-timeseries-of-app-performance-metrics-for-app-test.png differ diff --git a/static/sase/img/adem/DOCS-3771-network-performance-metircs-for-an-app.png b/static/sase/img/adem/DOCS-3771-network-performance-metircs-for-an-app.png new file mode 100644 index 000000000..bbbab1b7b Binary files /dev/null and b/static/sase/img/adem/DOCS-3771-network-performance-metircs-for-an-app.png differ diff --git a/static/sase/img/adem/DOCS-3772-remote-agent-score-aggregated-across-all-rn.png b/static/sase/img/adem/DOCS-3772-remote-agent-score-aggregated-across-all-rn.png new file mode 100644 index 000000000..52922e098 Binary files /dev/null and b/static/sase/img/adem/DOCS-3772-remote-agent-score-aggregated-across-all-rn.png differ diff --git a/static/sase/img/adem/DOCS-3773-zoom-meeting-data-for-a-particular-user.png b/static/sase/img/adem/DOCS-3773-zoom-meeting-data-for-a-particular-user.png new file mode 100644 index 000000000..60b3bc548 Binary files /dev/null and b/static/sase/img/adem/DOCS-3773-zoom-meeting-data-for-a-particular-user.png differ