Skip to content

DRAFT: A7S-641: Documentation for provider engagement performance improvement and behavior changes #766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alasdairhurst wants to merge 3 commits into
base: master
Choose a base branch
from
+18 −14
Open

DRAFT: A7S-641: Documentation for provider engagement performance improvement and behavior changes #766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe1091a
A7S-641: WIP docs
alasdairhurst Nov 24, 2025
8a4cbce
A7S-641: Fix linting
alasdairhurst Nov 24, 2025
c4a9a46
Update 2025nov_amplify.md
lbadenhop Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/get_actionable_insights/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The following roles can access the Insights dashboards:

* **Engage Administrators** can access both Business Insights and Consumer Insights dashboards. They can see metrics across all teams in the organization.
* **Catalog Manager** can view the Business Insights dashboards. Usage and metrics are scoped to their team. They must be a member in the owning team to view usage or engagement metrics.
* **Developer** can view only a subset of the Business Insights dashboards (API Health, API Traffic, Applications,Leaderboard). Their visibility is limited usage and metrics associated with their team membership.
* **Developer** can view only a subset of the Business Insights dashboards (API Health, API Traffic, Leaderboard). Their visibility is limited usage and metrics associated with their team membership.
* **Insights Viewer** can access the Business Insights dashboard. Their visibility is limited to usage and metrics associated with their team membership.
* **Consumer** and **Subscriber** can access Consumer Insights dashboard only.

Expand Down
30 changes: 17 additions & 13 deletions content/en/docs/get_actionable_insights/provider_engagement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ The Provider Engagement dashboard is visible to the following roles:

| Role | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Engage Admin** | Has full visibility across all provider teams and environments. Can view activity for all teams, including unassigned services or assets. |
| **Catalog Manager** | Can view metrics for assets, services and products owned by their team. |
| **Insights Viewer** | Can view metrics for assets, services and products owned by their team. |
| **Engage Admin** | Has full visibility across all provider teams and environments. Can view activity for all teams, including services, assets and products without an owner. |
| **Catalog Manager** | Can view metrics for services, assets and products owned by their team. |
| **Insights Viewer** | Can view metrics for services, assets and products owned by their team. |

## Dashboard components

Expand All @@ -46,38 +46,42 @@ Use this section to assess the current inventory of your provider ecosystem and
| **Teams** | Total number of provider teams currently defined in the organization. |
| **Services** | Total number of services currently registered in the Service Registry. |
| **Assets** | Total number of assets, categorized by lifecycle state (Draft, Active, Deprecated, Archived). |
| **Products** | Total number of products, categorized by lifecycle state (Draft, Active, Deprecated, Archived). Also displays the total number of *Published* products. This count can be filtered by one or more marketplaces, and is the only thing impacted by the Marketplace filter. |
| **Products** | Total number of products, categorized by lifecycle state (Draft, Active, Archived). Also displays the total number of *Published* products. This count can be filtered by one or more marketplaces, and is the only thing impacted by the Marketplace filter. |

### Team activity

The Team Activity section tracks how your teams are engaging over time — showing how many services, assets, and products were created or changed within a selected timeframe.
The Team Activity section tracks how your teams are engaging over time, showing how many services, assets, and products were created or changed within a selected timeframe.

You can view the data in two ways:

* **Chart view**: Aggregated events across all selected teams.
* **Table view**: Detailed breakdown per team.

Activity is associated to the provider team which owned the service, asset or product at that point in time.

Note: When viewing activity for a time range starting prior to *April 24, 2025*, all activity will reflect *current* provider team ownership instead. This difference in behavior will be displayed with an on-screen information.

#### Metrics tracked

| Category | Event Types Tracked | Description |
| Category | Activity | Description |
| ------------ | ---------------------------- | ------------------------------------------------------|
| **Services** | Created | Measures the creation of APIs and services by team in the selected time range. |
| **Services** | Created | Measures the creation of services by team in the selected time range. |
| **Assets** | Created, Activated, Deprecated, Archived | Tracks asset lifecycle activities in the selected time range, reflecting how teams evolve their APIs. |
| **Products** | Created, Activated, Published, Deprecated, Archived | Captures product lifecycle events in the selected time range, including publication activity. |
| **Products** | Created, Activated, Published, Archived | Captures product lifecycle events in the selected time range, including publication activity. |

#### Chart view

Visualize the level of engagement across all selected teams:
Visualize the level of engagement across all selected provider teams:

* Review total activities for the chosen timeframe.
* Use the granularity filter to display results by week or month.
* Identify trends such as spikes in activity following new initiatives or releases.

#### Table view

Examine the same activity data broken down per team:
Examine the same activity data broken down per provider team:

* Each row corresponds to a specific provider team.
* Shows "admin only" row for any product not owned by a team
* Columns show counts of events per object type (services, assets, products).
* Each row corresponds to services, assets or products owned by a specific provider team.
* Shows *Admin only* row for any services, assets or products not owned by a team.
* Columns show the number of unique services, assets, or products with the corresponding type of activity.
* Use this view to identify which teams are most active or need additional support.