updated per review requests

PaloAltoNetworks · Sep 28, 2023 · f5d9f35 · f5d9f35
1 parent 291f49e
commit f5d9f35
Show file tree

Hide file tree

Showing 20 changed files with 121 additions and 106 deletions.
diff --git a/...ss/docs/adem/examples/application-performance/mu-experience-score-for-an-app.md b/...ss/docs/adem/examples/application-performance/mu-experience-score-for-an-app.md
@@ -5,7 +5,8 @@ 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.
+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:
 
@@ -30,7 +31,7 @@ The following shows the portions of the UI widget where the data is displayed fo
         ],
         "rowCount": 462,
         "average": {
-            "application": 90
+            "application": 90   <<<<<<
         }
     }
 
diff --git a/...mples/application-performance/network-performance-metrics-for-an-application.md b/...mples/application-performance/network-performance-metrics-for-an-application.md
@@ -5,7 +5,8 @@ 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.
+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:
 
@@ -32,12 +33,12 @@ The following shows the portions of the UI widget where the data is displayed fo
         "series": [
             {
                 "_rowCount": 352,
-                "availability": 99.9,
-                "delay": 51399,
+                "availability": 99.9,   <<<<<<
+                "delay": 51399,   <<<<<<
                 "maxDelay": 485085,
-                "jitter": 17979.7,
+                "jitter": 17979.7,   <<<<<<
                 "maxJitter": 1005062,
-                "loss": 0.2,
+                "loss": 0.2,   <<<<<<
                 "maxLoss": 60,
                 "sample": 1691010000
             },

diff --git a/...-performance/timeseries-data-of-application-performance-for-all-applications.md b/...-performance/timeseries-data-of-application-performance-for-all-applications.md
@@ -5,7 +5,7 @@ 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.
+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:
 
@@ -32,7 +32,7 @@ The following shows the portions of the UI widget where the data is displayed fo
         "series": [
             {
                 "_rowCount": 3580,
-                "dnsLookupTime": 42.8,
+                "dnsLookupTime": 42.8,   <<<<<<
                 "maxDnsLookupTime": 530,
                 "throughput": 3316902.9,
                 "maxThroughput": 75128344,
@@ -44,11 +44,11 @@ The following shows the portions of the UI widget where the data is displayed fo
                 "maxWaitTime": 13142609,
                 "dataTransferTime": 264332,
                 "maxDataTransferTime": 15013933,
-                "timeToFirstByte": 525857.4,
+                "timeToFirstByte": 525857.4,   <<<<<<
                 "maxTimeToFirstByte": 13879987,
                 "totalTime": 828298.6,
                 "wireSize": 65611.4,
-                "availability": 1,
+                "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
@@ -5,7 +5,7 @@ description: Get an Application’s testUUID
 sidebar_label: Get an Application’s testUUID
 ---
 
-This API retrieves an application’s test UUID.
+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
 
@@ -34,8 +34,8 @@ This API retrieves an application’s test UUID.
             {
                 "rowCount": 13166,
                 "id": {
-                    "test": "<test-id>",
-                    "testName": "Google"
+                    "test": "<test-id>",   <<<<<<
+                    "testName": "Google"   <<<<<<
                 },
                 "average": {
                     "application": 91.6

diff --git a/...docs/adem/examples/application-test/distribution-for-an-app-test-per-segment.md b/...docs/adem/examples/application-test/distribution-for-an-app-test-per-segment.md
@@ -5,7 +5,8 @@ description: Fetch the distribution for a particular application test per segmen
 sidebar_label: Get Distribution for an Application Test Per Segment
 ---
 
-This API retrieves the distribution for a particular application test within a 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:
 
@@ -45,20 +46,20 @@ The following shows the portions of the UI widget where the data is displayed fo
                 }
             },
           {
-                "id": "lan",
+                "id": "lan",   <<<<<
                 "distribution": {
                     "clients": 17,
-                    "score": 82,   <<<<<< lan segment green
+                    "score": 82,   <<<<<< lan segment green indicating a good score
                     "poor": 0,
                     "fair": 6,
                     "good": 11
                 }
             }, ……..
             {
-                "id": "application",
+                "id": "application",   <<<<<<
                 "distribution": {
                     "clients": 22,
-                    "score": 90,  <<<google base app segment green
+                    "score": 90,  <<<<<< google base app segment green indicating a good score
                     "poor": 0,
                     "fair": 3,
                     "good": 19
@@ -68,7 +69,7 @@ The following shows the portions of the UI widget where the data is displayed fo
                 "id": "internet",
                 "distribution": {
                     "clients": 22,
-                    "score": 92, <<<<<internet segment green
+                    "score": 92, <<<<<< internet segment green indicating a good score
                     "poor": 0,
                     "fair": 2,
                     "good": 20

diff --git a/...ess/docs/adem/examples/application-test/distribution-for-an-application-test.md b/...ess/docs/adem/examples/application-test/distribution-for-an-application-test.md
@@ -5,7 +5,7 @@ description: Fetching the distribution for a particular application test (summar
 sidebar_label: Get the Distribution for an Application Test (Summary)
 ---
 
-This API retrieves the distribution for a particular application test.
+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:
 
@@ -29,15 +29,15 @@ The following shows the portions of the UI widget where the data is displayed fo
                "<tenant-id>:<subtenant-id>”    ],
         "classifier": "poor:[0 - 30],fair:[30 - 70],good:[70 - 100]",
         "entityCounts": {},
-        "collection": [
+        "collection": [   <<<<<<
             {
-                "id": "endpointScore",
+                "id": "endpointScore",   <<<<<<
                 "distribution": {
-                    "clients": 22,
-                    "score": 96,
-                    "poor": 0,
-                    "fair": 0,
-                    "good": 22
+                    "clients": 16,   <<<<<<
+                    "score": 90,   <<<<<<
+                    "poor": 0,   <<<<<<
+                    "fair": 2,   <<<<<<
+                    "good": 14   <<<<<<
                 }
             },
             {

diff --git a/...m/examples/application-test/global-distribution-of-app-score-for-an-app-test.md b/...m/examples/application-test/global-distribution-of-app-score-for-an-app-test.md
@@ -5,7 +5,7 @@ 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.
+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:
 
@@ -38,15 +38,15 @@ The following shows the portions of the UI widget where the data is displayed fo
             {
                 "rowCount": 9389,
                 "id": {
-                    "location": "Australia Southeast"
+                    "location": "Australia Southeast"   <<<<<<
                 },
                 "average": {
-                    "application": 82.8
+                    "application": 82.8   <<<<<<
                 },
                 "entityCounts": {
-                    "endpoint": 4,
+                    "endpoint": 4,   <<<<<<
                     "location": "Australia Southeast",
-                    "test": 1
+                    "test": 1   <<<<<<
                 }
             },
          
@@ -56,12 +56,12 @@ The following shows the portions of the UI widget where the data is displayed fo
                     "location": "US West"
                 },
                 "average": {
-                    "application": 93.1
+                    "application": 93.1   <<<<<<
                 },
                 "entityCounts": {
-                    "endpoint": 9,
-                    "location": "US West",
-                    "test": 1
+                    "endpoint": 9, <<<<<<
+                     "location": "US West",  <<<<<<
+                     "test": 1   <<<<<<
                 }
             }, ……..
             {
@@ -70,12 +70,12 @@ The following shows the portions of the UI widget where the data is displayed fo
                     "location": "UK"
                 },
                 "average": {
-                    "application": 96.6
+                    "application": 96.6   <<<<<<
                 },
                 "entityCounts": {
-                    "endpoint": 2,
-                    "location": "UK",
-                    "test": 1
+                    "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
@@ -5,7 +5,7 @@ description: Network Performance Metrics
 sidebar_label: Get Network Performance Metrics
 ---
 
-This API retrieves the 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:
 
@@ -33,11 +33,11 @@ The following shows the portions of the UI widget where the data is displayed fo
             {
                 "_rowCount": 3681,
                 "availability": 99.5,
-                "delay": 81472.1,
+                "delay": 81472.1,   <<<<<<
                 "maxDelay": 1151403,
-                "jitter": 26321.4,
+                "jitter": 26321.4,   <<<<<<
                 "maxJitter": 6596877,
-                "loss": 0.6,
+                "loss": 0.6,   <<<<<<
                 "maxLoss": 100,
                 "sample": 1691334000
             },

diff --git a/...s/access/docs/adem/examples/application-test/timeseries-data-for-an-app-test.md b/...s/access/docs/adem/examples/application-test/timeseries-data-for-an-app-test.md
@@ -5,7 +5,8 @@ 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.
+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:
 

diff --git a/...mples/application-test/timeseries-of-app-performance-metrics-for-an-app-test.md b/...mples/application-test/timeseries-of-app-performance-metrics-for-an-app-test.md
@@ -5,7 +5,7 @@ description: Timeseries of Application Performance Metrics for a particular appl
 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.
+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:
 
@@ -32,7 +32,7 @@ The following shows the portions of the UI widget where the data is displayed fo
         "series": [
             {
                 "_rowCount": 351,
-                "dnsLookupTime": 46.5,
+                "dnsLookupTime": 46.5,   <<<<<<
                 "maxDnsLookupTime": 408,
                 "throughput": 767161.6,
                 "maxThroughput": 2836784,
@@ -44,11 +44,11 @@ The following shows the portions of the UI widget where the data is displayed fo
                 "maxWaitTime": 1608543,
                 "dataTransferTime": 67118.8,
                 "maxDataTransferTime": 2269218,
-                "timeToFirstByte": 428691.5,
+                "timeToFirstByte": 428691.5,   <<<<<<
                 "maxTimeToFirstByte": 9268485,
                 "totalTime": 511078.7,
                 "wireSize": 18130.7,
-                "availability": 0.9,
+                "availability": 0.9,   <<<<<<
                 "sample": 1691010000
             },…..
     ]

diff --git a/...ples/application-test/top-20-applications-lowest-to-highest-experience-score.md b/...ples/application-test/top-20-applications-lowest-to-highest-experience-score.md
@@ -5,7 +5,8 @@ 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.
+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:
 
@@ -49,20 +50,20 @@ The following shows the portions of the UI widget where the data is displayed fo
                 "rowCount": 23132,
                 "id": {
                     "test": "<test-id>",
-                    "testName": "Dropbox"
+                    "testName": "Dropbox"   <<<<<<
                 },
                 "average": {
-                    "application": 31
+                    "application": 31   <<<<<<
                 }
             },
             {
                 "rowCount": 7781,
                 "id": {
                     "test": "<test-id>",
-                    "testName": "AWS"
+                    "testName": "AWS"   <<<<<<
                 },
                 "average": {
-                    "application": 34.7
+                    "application": 34.7   <<<<<<
                 }
             },
             {

diff --git a/...es/mobile-users/distribution-of-mu-agent-scores-by-endpoint-across-all-tests.md b/...es/mobile-users/distribution-of-mu-agent-scores-by-endpoint-across-all-tests.md
@@ -5,7 +5,12 @@ 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.
+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:
 
@@ -52,13 +57,13 @@ The following shows the portions of the UI widget where the data is displayed fo
                 }
             },
             {
-                "id": "lan",
+                "id": "lan",   <<<<<<
                 "distribution": {
                     "clients": 17,
-                    "score": 81,
-                    "poor": 0,
-                    "fair": 5,
-                    "good": 12
+                    "score": 81,   <<<<<<
+                    "poor": 0,   <<<<<<
+                    "fair": 5,   <<<<<<
+                    "good": 12   <<<<<<
                 }
             },
             {
@@ -92,13 +97,13 @@ The following shows the portions of the UI widget where the data is displayed fo
                 }
             },
             {
-                "id": "internet",
+                "id": "internet",   <<<<<<
                 "distribution": {
                     "clients": 22,
-                    "score": 89,
-                    "poor": 0,
-                    "fair": 1,
-                    "good": 21
+                    "score": 89,   <<<<<<
+                    "poor": 0,   <<<<<<
+                    "fair": 1,   <<<<<<
+                    "good": 21   <<<<<<
                 }
             }
         ]