Merge pull request #516 from mulesoft/W-13480493-update-UI-mule-API-analytics-gr

W 13480493 update UI mule api analytics gr

Author: glenn-rodgers-sf

modules/ROOT/nav.adoc

@@ -54,11 +54,11 @@
   ** xref:proxy-mule3-elements.adoc[Filter Mule Headers in Mule 3.x API Proxies]
  ** xref:proxy-domain-support.adoc[Automatic Domain Support for Mule 4 API Proxies]
 * xref:manage-policies-overview.adoc[Policies]
-* xref:analytics-landing-page.adoc[View Analytics]
- ** xref:viewing-api-analytics.adoc[Review Analytics Usage]
- ** xref:analytics-chart.adoc[Review Analytics Charts Usage]
- ** xref:analytics-event-api.adoc[Review Analytics Event API]
- ** xref:analytics-event-forward.adoc[Review Analytics Event Forwarding]
+* xref:analytics-landing-page.adoc[View Mule API Analytics]
+ ** xref:viewing-api-analytics.adoc[Review Mule API Analytics Usage]
+ ** xref:analytics-chart.adoc[Review Mule API Analytics Charts Usage]
+ ** xref:analytics-event-api.adoc[Review Mule API Analytics Event API]
+ ** xref:analytics-event-forward.adoc[Review Mule API Analytics Event Forwarding]
 * xref:mule-oauth-provider-landing-page.adoc[Mule OAuth 2.0 Provider]
  ** xref:about-configure-api-for-oauth.adoc[OAuth 2.0 Policy Prerequisites]
  ** xref:external-oauth-2.0-token-validation-policy.adoc[OAuth 2.0 Access Token Enforcement Using Mule OAuth Provider]

modules/ROOT/pages/analytics-chart.adoc

@@ -1,15 +1,15 @@
-= Reviewing API Manager Analytics Charts Usage
+= Reviewing API Manager Mule API Analytics Charts Usage
 ifndef::env-site,env-github[]
 include::_attributes.adoc[]
 endif::[]
 
-API Analytics provides a summary in chart form of requests, top apps, and latency for 1 hour, 3 hours, 1 day, 7 days, or 1 month. This data is available for 30 days. To view the Analytics chart, in API Manager, click the instance name of a deployed API.
+Mule API Analytics provides a summary in chart form of requests, top apps, and latency for 1 hour, 3 hours, 1 day, 7 days, or 1 month. This data is available for 30 days. To view the Mule API Analytics chart, in API Manager, click the instance name of a deployed API.
 
-*Note:* To view Analytics charts, users need View APIs Configuration permission. See xref:environment-permission-task.adoc[To Set Permissions].
+*Note:* To view Mule API Analytics charts, users need `View APIs Configuration` permission. See xref:environment-permission-task.adoc[To Set Permissions].
 
 == Reviewing Requests Summary Chart
 
-The requests summary chart lists the total number of requests to your API by the duration you choose. The chart shows the HTTP status codes specified by W3C. For example:
+The requests summary chart lists the total number of requests to your API instance by the duration you choose. The chart shows the HTTP status codes specified by W3C. For example:
 
 image::request-analytics.png["Summary chart of the total number of requests for June 1, 2017, shown by one hour duration."]
 
@@ -21,7 +21,7 @@ Graph lines are provided for:
 
 == Reviewing Top Apps Summary Chart
 
-The top apps summary chart lists the number of requests made to the API by each application for the top 5 applications calling that API. Each color represents one of the top 5 applications accessing the API. The y-axis plots the number of calls made to the API.
+The top apps summary chart lists the number of requests made to the API instance by each application for the top 5 applications calling that API instance. Each color represents one of the top 5 applications accessing the API. The y-axis plots the number of calls made to the API instance.
 
 The graph lists the number of requests over the duration you select, for example:
 
@@ -37,9 +37,9 @@ image::performance-analytics.png["A latency summary chart showing the average la
 
 == Including Policy Violations in Charts
 
-*Note:* Users must have the View Policies permission set to view policies or edit a Policy Violation alert.
+*Note:* Users must have the `View Policies` permission set to view policies or edit a Policy Violation alert.
 
-Enable or disable the tracking of policy violations by checking the Include Policy Violations checkbox on an Analytics chart screen. The chart shows traffic rejected, or not rejected, by a policy.
+Enable or disable the tracking of policy violations by checking the Include Policy Violations checkbox on an Mule API Analytics chart screen. The chart shows traffic rejected, or not rejected, by a policy.
 
 image::policy-violations-dashboard.png["An analytics chart screen with the Include Policy Violations checkbox indicated with a callout."]
 

modules/ROOT/pages/analytics-event-api.adoc

@@ -1,12 +1,12 @@
-= Reviewing Analytics Event API
+= Reviewing Mule API Analytics Event API
 ifndef::env-site,env-github[]
 include::_attributes.adoc[]
 endif::[]
 :keywords: analytics, api, reports
 
 //Rename topic to Generating Analytics Reports for APIs
 
-API Manager gathers analytics data for each API that you manage.  You can generate this data in reports and charts, using the Analytics Event API. You can create reports for a specific environment or for multiple APIs, and you can create different reports for the same API.
+API Manager gathers analytics data for each Mule API that you manage. You can generate this data in reports and charts, using the Analytics Event API. You can create reports for a specific environment or for multiple APIs, and you can create different reports for the same API.
 
 == Requirements and Restrictions
 
@@ -22,7 +22,7 @@ Before you start using the API to create reports, consider the following require
 * Although the Analytics Events API enforces a limit of 10 requests per minute, the best practice is 1 request per minute. 
 * Do not use the Analytics Events API for data synchronization. 
 +
-If you need to synchronize data for events with an external system, see xref:analytics-event-forward.adoc[Analytics Event Forwarding].
+If you need to synchronize data for events with an external system, see xref:analytics-event-forward.adoc[Mule API Analytics Event Forwarding].
 
 
 == Create a Report
@@ -31,7 +31,7 @@ You can create a report to find API events, such as policy violations due to rat
 
 To create a report:
 
-. Navigate to *API Manager > Analytics > Manage Reports* and click *New*.
+. Navigate to *API Manager* > *Mule Analytics* > *Manage Reports* and click *New*.
 . In *Create Report*, select a data source, range, and format.
 . In *Fields*, select *Violated Policy Name*.
 . Save the report.
@@ -80,7 +80,7 @@ This command sends a request to the authentication servers of the Anypoint Platf
 ----
 +
 . Append the access token to the `Authorization` header in the request of the Analytics Reporting API endpoint for your report:
-.. Copy the endpoint from the *Manage Reports* page in the Analytics dashboard.  
+.. Copy the endpoint from the *Manage Reports* page in the Mule API Analytics dashboard.  
 .. Include the `$TOKEN` variable from the previous step in the next request, as shown in the following example that retrieves analytics for organizations without environments:
 +
 [source,console]
@@ -98,7 +98,7 @@ curl -H "Authorization: Bearer $TOKEN" "https://anypoint.mulesoft.com:443/analyt
 ----
 
 In this example, analytics data is retrieved for the past 30 days from the API with the API ID <API_ID>. The results are generated in a CSV format. 
-+
+
 The following example combines two `curl` commands and displays values in the command prompt window:
 
 [source,text,linenums]
@@ -183,7 +183,7 @@ Timestamp, API Name, API ID, API Version, API Version ID are always included. +
 *Type:* string +
 *Required:* yes +
 *Example:* `format=csv`
-|maxResults |Maximum number of events to return. Default value is `20000`.+
+|maxResults |Maximum number of events to return. Default value is `20000`. +
 
 *Type:* integer +
 *Required:* no +
@@ -240,12 +240,12 @@ Your report can query data for one or more of the available data fields:
 In your query, if the `Content-Length` header is:
 
 * Present: `Response Size` is set to that value. 
-* Not present and the payload is a String: Analytics calculates the length of the String and reports that value. 
-* Not present and the payload is not a String: Analytics reports the response size as -1. 
+* Not present and the payload is a String: Mule API Analytics calculates the length of the String and reports that value. 
+* Not present and the payload is not a String: Mule API Analytics reports the response size as -1. 
 +
 For example, if the output returned is a DataWeave stream and the `Content-Length` header is not present, the Analytics Event API does not report a response size because the value is not a String. However if your application performs a String conversion, the response size is listed.
 
 == See Also
 
-* xref:viewing-api-analytics.adoc[Viewing API Analytics]
+* xref:viewing-api-analytics.adoc[Viewing Mule API Analytics]
 * https://stedolan.github.io/jq/[jq command-line JSON processor]

modules/ROOT/pages/analytics-event-forward.adoc

@@ -1,23 +1,23 @@
-= Reviewing Analytics Event Forwarding
+= Reviewing Mule API Analytics Event Forwarding
 ifndef::env-site,env-github[]
 include::_attributes.adoc[]
 endif::[]
 
-Sometimes you need to forward the Anypoint API Analytics events to a third-party system. An example of this could be integrating with ELK or other analytics system.
+Sometimes you need to forward the Mule API Analytics events to a third-party system. An example of this could be integrating with ELK or other analytics system.
 
 There are three ways to export events:
 
 * Use the API Analytics Report API to pull the data. One consideration with this method is that the API has limit on the number and frequency of events that can be reported. Additionally, events may have delays of up to 10 minutes from the time the event is generated to the moment it is available for query.
 
-* Forward API Analytics events from the Gateway to configured HTTP endpoint. To configure this on CloudHub, configure the `anypoint.platform.analytics_base_uri` gateway property from the Settings tab of Runtime Manager.
+* Forward Mule API Analytics events from the Gateway to configured HTTP endpoint. To configure this on CloudHub, configure the `anypoint.platform.analytics_base_uri` gateway property from the Settings tab of Runtime Manager.
 +
 Setting this property configures the base URL where the events are posted.
 
 image::analytics-event-forwarding.png[Event Forwarding]
 
 In the example shown above, the events are published to `+http://<your-address-here>/v2/analytics/events+` using the POST method and GZIP for compression.
 
-The disadvantage of this approach is that events are not published to Anypoint Platform and neither API Analytics nor API Manager display information about API calls.
+The disadvantage of this approach is that events are not published to Anypoint Platform and neither Mule API Analytics nor API Manager display information about API calls.
 
 * Use Runtime Manager to xref:runtime-manager::sending-data-from-arm-to-external-analytics-software.adoc[Export Data to External Analytics Tools]
 

modules/ROOT/pages/analytics-landing-page.adoc

@@ -1,18 +1,20 @@
-= Analytics
+= Mule API Analytics
 ifndef::env-site,env-github[]
 include::_attributes.adoc[]
 endif::[]
 :keywords: analytics
 
-API Analytics can provide insight into how your APIs are being used and how they are performing. From API Manager, you can access the Analytics dashboard, create a custom dashboard, create and manage charts, and create reports. From API Manager, you can get following types of analytics:
+NOTE: *Mule API Analytics* does not support Flex Gateway APIs. For Flex Gateway Analytics, see xref:gateway::flex-view-api-metrics.adoc[].
+
+Mule API Analytics can provide insight into how your Mule APIs are being used and how they are performing. From API Manager, you can access the Mule API Analytics dashboard, create a custom dashboard, create and manage charts, and create reports. From API Manager, you can get following types of analytics:
 
 * API viewing analytics
 * API events analytics
 * Charted metrics in API Manager
 
-You can view data from a policy perspective in the Analytics dashboard, Analytics chart, or API Manager by including policy violations. This action tracks traffic rejected, or not rejected, by a policy.
+You can view data from a policy perspective in the Mule API Analytics dashboard, Mule API Analytics chart, or API Manager by including policy violations. This action tracks traffic rejected, or not rejected, by a policy.
 
-NOTE: The Analytics link is visible only to users who have `Read API` permission. Charts are visible for users who have `View Analytics` permission.
+The *Mule API Analytics* tab is visible only to users who have `Read API` permission. Charts are visible for users who have `View Analytics` permission.
 
 == See Also
 

modules/ROOT/pages/api-proxy-landing-page.adoc

@@ -49,9 +49,9 @@ You can deploy a proxy directly to a xref:runtime-fabric::index.adoc[Runtime Fab
 * Enables customization
 +
 In most cases, the proxy generated in API Manager is suitable for deployment. However, in the Mule environment, you can use xref:studio::import-export-packages.adoc[Anypoint Studio] to edit the proxy to meet custom requirements.
-* Secures and governs your APIs using policies and xref:viewing-api-analytics.adoc[API analytics]
+* Secures and governs your APIs using policies and xref:viewing-api-analytics.adoc[Mule API Analytics]
 +
-The proxy enables you to protect your API with the full capabilities of the API gateway, including access to API Analytics.
+The proxy enables you to protect your API with the full capabilities of the API gateway, including access to Mule API Analytics.
 * Implements validations
 +
 Most proxies, including RAML, REST, and WSDL proxies, enable you to perform validations on all incoming requests, using your API definition. You can choose different levels of validation, depending on your requirements:

modules/ROOT/pages/latest-overview-concept.adoc

@@ -45,9 +45,9 @@ _Custom policies_ are policies that anyone can develop and apply to their APIs,
 * *DataGraph Administration*
 +
 Anypoint DataGraph enables you to unify all the data within your application network in a unified schema. For details, see xref:datagraph::index.adoc[Anypoint DataGraph Overview]. *DataGraph Administration* is only visible after you configure a Datagraph unified schema.
-* *Analytics*
+* *Mule API Analytics*
 +
-API analytics provide insight into how your APIs are being used and how they are performing. For details, see xref:viewing-api-analytics.adoc[Reviewing Analytics Usage].
+Mule API Analytics provide insight into how your Mule APIs are being used and how they are performing. For details, see xref:viewing-api-analytics.adoc[Reviewing Mule API Analytics Usage].
 
 . The *Add API* button. Enables you to add a new API instance, to promote an API from any environment to the current environment, or to import a configuration ZIP file that was exported from API Manager. For details, see xref:getting-started-proxy.adoc[Getting Started with Managing an API].
 

modules/ROOT/pages/proxy-advantages.adoc

@@ -10,7 +10,7 @@ The tables below describe the main benefits and impacts of implementing the diff
 [%header%autowidth.spread]
 |===
 | Benefit | WSDL | RAML/OAS | HTTP | HTTPS
-| Tracks proxy in API Manager and generates API analytics. Requires Autodiscovery.
+| Tracks proxy in API Manager and generates Mule API analytics. Requires Autodiscovery.
 | yes
 | yes
 | yes

modules/ROOT/pages/viewing-api-analytics.adoc

@@ -1,16 +1,21 @@
-= Reviewing Analytics Usage
+= Reviewing Mule API Analytics Usage
 ifndef::env-site,env-github[]
 include::_attributes.adoc[]
 endif::[]
 :keywords: analytics, dashboard
 
-After logging into Anypoint Platform, navigate to API Manager, and on the Administration page, click Analytics to open the dashboard.  From the dashboard, you can navigate to the analytics about your APIs gathered by Anypoint Platform.
+You can view your Mule API Analytics data from both API Manager and Anypoint Monitoring. API Manager retains the Mule API Analytics data for up to 30 days. However, Anypoint Monitoring provides more robust API usage data with a retention period of 30 days.
 
-You can view your API Analytics data from both API Manager and Anypoint Monitoring. API Manager retains the API Analytics data for up to 30 days. However, Anypoint Monitoring provides more robust API usage data with a retention period of 30 days.
+To view Mule API Analytics Data in API Manager:
+
+. Go to *Anypoint Platform* > *API Manager*.
+. Click *Mule API Analytics*.
+
+From the dashboard, you can navigate to the analytics about your APIs gathered by Anypoint Platform.
 
 For more information about how you can view your data in Anypoint Monitoring, see xref:monitoring::api-analytics-dashboard.adoc[Anypoint Monitoring API Analytics Dashboard].
 
-When you access the analytics for your APIs, by default you land on your Overview Dashboard that displays these charts:
+When you access the analytics for your Mule APIs, by default you land on your Overview Dashboard that displays these charts:
 
 * *Requests by Date*: Line chart that shows the number of requests for all APIs in your organization.
 * *Requests by Location*: Map chart that shows the number of requests for each country of origin.
@@ -42,7 +47,7 @@ If you have filtered data on one of the charts to show only selected data, the e
 
 == Including Policy Violations on the Dashboard
 
-*Note:* Users must have the View Policies permission set to view policies or edit a Policy Violation alert.
+*Note:* Users must have the `View Policies` permission set to view policies or edit a Policy Violation alert.
 For more information, see xref:environment-permission-task.adoc[Setting permissions].
 
 Enable or disable the tracking of policy violations by checking the Include Policy Violations checkbox on the dashboard. The dashboard will show traffic rejected, or not rejected, by a policy.
@@ -66,7 +71,7 @@ Only charts that group by Violated Policy Name include events that triggered a p
 
 To create a custom chart, click Manage Charts:
 
-. In API Manager > Analytics > Manage Charts, click New.
+. Navigate to *API Manager* > *Mule API Analytics* > *Manage Charts* and click *New*.
 +
 Create Chart appears.
 +
@@ -140,7 +145,7 @@ The custom chart appears.
 
 === Example Custom Chart: Policy Violations Per Application
 
-. In API Manager > Analytics > Manage Charts, click New.
+. Navigate to *API Manager* > *Mule API Analytics* > *Manage Charts* and click *New*.
 . In Title, type *Policy Violations Per Application*.
 . In Description, type *Number of violations per subscribed application*
 . Select a stack chart.
@@ -165,7 +170,7 @@ After you create custom charts, you can display them side by side on a custom da
 
 To access your custom dashboard, click the Custom Dashboard. The first time you open your custom dashboard, it is blank.
 
-. In API Manager > Analytics > Custom Dashboard, click Edit Dashboard.
+. Navigate to *API Manager* > *Mule API Analytics* > *Custom Dashboard* and click *Edit Dashboard*.
 . Assuming you created custom charts, drag and drop charts from the drawer on the left of the screen onto your dashboard, rearranging them as needed into the order that you want.
 +
 . After you add a chart to your dashboard, you have the option to open it for editing or click the X to remove it from your dashboard.