Managing your Products

You can manage your Products in API Manager by using the Products tab of the associated Catalog. In this view, you can move the Products through their lifecycle, display analytics information, and control who can see or subscribe to the Products. The syndication feature in IBM® API Connect means that Products can also be managed by using the Products tab of the associated Space.

To manage your Product, complete the following steps.

1. On the Dashboard of the API Manager UI, select the Catalog that you want to work with.
   The Products tab of the Catalog opens, and all of the Products available in that Catalog are displayed. You can select which states are shown by clicking the filter icon in the Search banner and selecting one or more of the State check boxes.
2. If the Product that you want to work with is contained within a Space, select the required Space by clicking the down arrow next to the Catalog name in the submenu navigation banner.
   The Products tab of the Space opens, and all of the Products available in that Space are displayed. You can select which states are shown by using the filter check boxes in the State bar.
3. Click a Product name to expand the view and see further details.
   For each Product version you can see the following details and options:

   • The name of the Product version.
   • The current lifecycle state of the Product (staged, published, deprecated, retired, or archived).
   • The APIs that are included in the Product and whether they are online or offline. You can use the slider to quickly make an API offline or online. For example, if maintenance work on the API is needed, move the slider to the off position while the work is being performed, and then move the slider back to the on position after the work is complete.
   • The Plans that are included in the Product, and the number of subscribers that are subscribed to each Plan.
   • Manage actions are also available, depending on the state of the Product. To view the manage actions, click the Manage icon and select the action that you require. To view the manage actions, click the Manage icon and select the action that you require.
4. To display the analytics information for a version of a Product from the expanded Product view, click the Manage icon for that Product version, and then click Product analytics. To display the analytics information for a version of a Product from the expanded Product view, click the Manage icon for that Product version, and then click Product analytics.
   You are redirected to the Analytics tab, which shows an analytics dashboard for the Product. The default dashboard is titled Catalog_name - Product_name or Space_name - Product_name, and shows analytics information in the form of visualizations, which are represented as charts and numerical metrics. The default dashboard for the Product displays the following metrics and charts for the last seven days:

   • The developer organization usage
   • The number of calls that are made to all APIs included in the Product
   • A pie chart that shows the distribution of applications that have accessed each Plan in the Product
   • A bar chart that shows the number of API calls per day
     Restriction: If the visualizations in your dashboards display no data or show data only for a time period in the past, a possible reason might be that access to analytics data within API Connect has been switched off. Contact your cloud administrator for confirmation. (For more information, see Configuring destination targets for API Connect analytics data.)

   The dashboard for the Product is similar in layout to the analytics dashboards for Catalogs and provides similar functions. For a description of the layout of the screen elements, see The default Overview dashboard. You can work with the dashboard as follows:

   • Modify the dashboard by adding, editing, or removing visualizations, or by resizing or rearranging the visualizations.
   • Apply filters to change the time range of the data displayed or the type of data displayed, and also set an auto-refresh rate for the data.
   • Share a view of your customized dashboard with other users.
   • View and export the raw analytics data and API event records that are collated for each visualization, and also export the API event data that is associated with the entire dashboard to a CSV file.

   Note: Below the search bar on the dashboard, the blue oval and Actions twistie, which are displayed, depict the inclusion filter that is applied for the Product-based data shown in the visualizations. Below the search bar on the dashboard, the green oval and Actions twistie, which are displayed, depict the inclusion filter that is applied for the Product-based data shown in the visualizations.

   To return to the list of Products, click the Products tab again.

5. To display the analytics information for a Plan from the expanded Product view, click the Analytics icon for that Plan.
   You are redirected to the Analytics tab, which shows an analytics dashboard for the Plan. The default dashboard is titled Catalog_name - Product_name:Product_version:Plan_name or Space_name - Product_name:Product_version:Plan_name, and displays the following metrics and chart for the last seven days:

   • The number of calls that are made to all APIs that are subscribed to the Plan in that Product
   • The number of applications that are subscribed to the Plan
   • A line chart that tracks the number of calls made by an application within the defined rate limit time window against the maximum number of calls allowed during that time window; this view helps in identifying calls that exceeded the rate limit, and which were either rejected with a 429 status code or recorded in the Activity log
     Restriction: If the visualizations in your dashboards display no data or show data only for a time period in the past, a possible reason might be that access to analytics data within API Connect has been switched off. Contact your cloud administrator for confirmation. (For more information, see Configuring destination targets for API Connect analytics data.)

   The dashboard for the Plan is similar in layout to the analytics dashboards for Catalogs and provides similar functions. For a description of the layout of the screen elements, see The default Overview dashboard. You can work with the dashboard as follows:

   • Modify the dashboard by adding, editing, or removing visualizations, or by resizing or rearranging the visualizations.
   • Apply filters to change the time range of the data displayed or the type of data displayed, and also set an auto-refresh rate for the data.
   • Share a view of your customized dashboard with other users.
   • View and export the raw analytics data and API event records that are collated for each visualization, and also export the API event data that is associated with the entire dashboard to a CSV file.

   Note: Below the search bar on the dashboard, the blue ovals and Actions twistie, which are displayed, depict the inclusion filters that are applied for the Product and Plan-based data shown in the visualizations. Below the search bar on the dashboard, the green ovals and Actions twistie, which are displayed, depict the inclusion filters that are applied for the Product and Plan-based data shown in the visualizations.

   To return to the list of Products, click the Products tab again.

6. To display the analytics information for an API from the expanded Product view, click the Analytics icon for that API.

   You are redirected to the Analytics tab, which shows an analytics dashboard for the API. The default dashboard is titled Catalog_name - API_name or Space_name - API_name, and displays the following charts and metrics for the last seven days:

   • A pie chart that shows the total count for each status code that was generated for the API over the time period
   • A bar chart that shows the distribution of error types that were generated each day
   • The minimum time taken to process the API request in milliseconds
   • The average time taken to process the API request in milliseconds
   • The maximum time taken to process the API request in milliseconds
   • A line chart that collectively tracks the minimum, average, and maximum time taken to process the API request in milliseconds, for comparison
   • The total number of calls that were made to the API
   • A bar chart that shows the number of calls per day to the API
     Restriction: If the visualizations in your dashboards display no data or show data only for a time period in the past, a possible reason might be that access to analytics data within API Connect has been switched off. Contact your cloud administrator for confirmation. (For more information, see Configuring destination targets for API Connect analytics data.)

   The dashboard for the API is similar in layout to the analytics dashboards for Catalogs and provides similar functions. For a description of the layout of the screen elements, see The default Overview dashboard. You can work with the dashboard as follows:

   • Modify the dashboard by adding, editing, or removing visualizations, or by resizing or rearranging the visualizations.
   • Apply filters to change the time range of the data displayed or the type of data displayed, and also set an auto-refresh rate for the data.
   • Share a view of your customized dashboard with other users.
   • View and export the raw analytics data and API event records that are collated for each visualization, and also export the API event data that is associated with the entire dashboard to a CSV file.

   Note: Below the search bar on the dashboard, the blue oval and Actions twistie, which are displayed, depict the inclusion filter that is applied for the API-based data shown in the visualizations. Below the search bar on the dashboard, the green oval and Actions twistie, which are displayed, depict the inclusion filter that is applied for the API-based data shown in the visualizations.

   To return to the list of Products, click the Products tab again.

7. To manage the lifecycle of a version of a Product, click the Manage icon alongside the Product version, and select the required lifecycle action.
8. To view the approval history of a version of a Product, click the Manage icon alongside the Product version, and select Approval history.
9. To set the migration target of a version of a Product, click the Manage icon alongside the Product version, and select Set migration target. In the Set migration target window, select the Product that you want to set as the migration target, and select Next. Then map the migration source Plans to the migration target Plans, and click OK.
   The migration target is displayed next to the migration source Plans. For information about how to migrate the subscriptions to the target Product, see Migrating application subscriptions to another Plan.

   Restriction: If the Plan is part of a Product that is contained within a Space in the Catalog, and the migration action is being made at the Space level, the Plan that you are migrating subscriptions from must be located in the same Space as the Plan you are migrating to. If the migration action is being made at the Catalog level, subscriptions can be migrated across Spaces. For more information about the Space feature, see Using syndication in IBM API Connect.