Skip to content

Commit

Permalink
Merge pull request #513 from sarette/publish-9-29-2023
Browse files Browse the repository at this point in the history
Publish 9 29 2023
  • Loading branch information
jonathan-ly authored Sep 29, 2023
2 parents d4811ab + d118c35 commit f991dc7
Show file tree
Hide file tree
Showing 21 changed files with 72 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ 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.
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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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.
This API retrieves the Network Performance Metrics for a given application.

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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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.
This API retrieves the timeseries data of application performance for all applications.

In the Response section, the values shown for each field that is followed by a comment (<<<<<<), 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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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. 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.
This API retrieves the distribution for a particular application test within a segment.


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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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. 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.
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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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.
This API retrieves the global distribution of application scores for a given application test.

In the Response code, the lines that are marked with (<<<<<<) correspond to the area in the UI (see attached screenshot) that are marked with red arrows.

The following shows the portions of the UI widget where the data is displayed for this example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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.
This API retrieves the Network Performance Metrics.

In the Response section, the values shown 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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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.
This API retrieves the Timeseries data for a given application test.

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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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. 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%.
This API retrieves the Timeseries of the Application Performance Metrics for a particular application test.

In the Response section, 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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ 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.
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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ 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
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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ 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.
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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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.
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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ description: Fetch all the Mobile Users ADEM agents logged in for the last 30 da
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.
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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ description: Global Distribution of Application Experience Scores for Mobile Use
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 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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ 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.
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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ 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.
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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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
You can retrieve all the same metrics for Remote Networks that you can retrieve 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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ 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.
This API retrieves zoom meeting data for a particular user.

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:
Expand Down
2 changes: 1 addition & 1 deletion products/sase/docs/release-notes/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ keywords:

| Date | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| July 17, 2023 | Added [Autonomous DEM APIs](/access/docs/adem). |
| September 28, 2023 | Added [Autonomous DEM APIs](/access/docs/adem) and [ADEM API Examples](/access/docs/adem/examples/application-performance/mu-experience-score-for-an-app/). |
| May 16, 2023 | Added [Custom Roles](/sase/api/iam/custom-roles/) and [Permission Sets](/sase/api/iam/permission-sets/) to the Identity and Access Management APIs. |
| April 26, 2023 | Added [ZTNA Connector APIs](/sase/docs/release-notes/release-notes/#april-2023) and miscellanous other changes. |
| March 28, 2023 | New endpoints for the [Prisma Access Configuration APIs](/sase/docs/release-notes/release-notes/#march-2023). |
Expand Down
12 changes: 12 additions & 0 deletions products/sase/docs/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ see the following for information about non-API feature enhancements and known i
See also the [change log](/sase/docs/release-notes/changelog) for information on all changes to this API documentation, some of which have
occurred in between API product releases.

## September 2023

Added [Autonomous DEM](/access/api/adem/autonomous-dem-api/) APIs. Use the ADEM APIs to access the Autonomous Digital
Experience Management summary, distribution and timeseries data, such as application score and agent
scores.

Added [examples](/access/docs/adem/examples/application-performance/mu-experience-score-for-an-app/)
that correlate fields in response structures to the area in the UI which displays that data.

For more information on AI-Powered Autonomous DEM, see
[AI-Powered Autonomous DEM](https://docs.paloaltonetworks.com/autonomous-dem/administration).

## April 2023

Added [ZTNA Connector](/access/api/ztna/ztna-connector-apis/) APIs.
Expand Down

0 comments on commit f991dc7

Please sign in to comment.