Skip to content

Commit 92a5e36

Browse files
Merge pull request #6017 from RushanNanayakkara/master
Add M2M insights documentation
2 parents f09c3b5 + 390e87c commit 92a5e36

2 files changed

Lines changed: 35 additions & 5 deletions

File tree

59.4 KB
Loading

en/includes/guides/organization-insights.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ To check insights of your organization:
1313

1414
- **Login** - displays insights related to successful and failed user logins made to business applications and the My Account portal.
1515
- **Registration** - displays insights related to user registrations via self sign-up and admin-initiated registration methods.
16+
- **M2M** - displays insights related to machine-to-machine (M2M) token issuance.
1617

1718
3. Use the dropdown in the top right corner to adjust the duration.
1819

@@ -27,23 +28,26 @@ The example below shows insights related to login events of the organization for
2728
The statistics displayed in the graphs are not real-time. </br></br>
2829

2930
Why? </br>
30-
There is a latency of up to 20 minutes between the user activity and insights. This delay ensures accurate data processing and allows for a more comprehensive analysis of user logins and login trends.
31-
31+
There is a latency of up to 20 minutes between the user activity and insights. This delay ensures accurate data processing and allows for a more comprehensive analysis of all activities including logins, registrations, and M2M token usage.
3232

3333
## User engagement metrics
34+
3435
This section will help you further understand the statistics shown in the graphs.
3536

3637
### Active Users
38+
3739
This graph in login insights, represents the number of unique user logins within the selected duration. You can view each day's count by hovering your mouse over a point on the graph. This metric helps measure the daily engagement of users with the platform.
3840

3941
![Unique active users]({{base_path}}/assets/img/guides/organization-insights/active-users-graph.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
4042

4143
### Total Logins
44+
4245
This graph in login insights, represents the total number of successful user logins within the selected duration. By hovering your mouse over a point on the graph, you can view the specific count of user logins for each day.
4346

4447
![Total user logins]({{base_path}}/assets/img/guides/organization-insights/total-logins-graph.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
4548

4649
### Failed Logins
50+
4751
This graph in login insights, represents the total number of failed logins within the selected duration. You can view each day's failed login attempt count by hovering your mouse over a point on the graph.
4852

4953
![Failed login attempts]({{base_path}}/assets/img/guides/organization-insights/failed-logins-graph.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
@@ -52,17 +56,29 @@ This graph in login insights, represents the total number of failed logins withi
5256
The graph does not include data related to failed login attempts made by the organization owner or administrators to either the {{ product_name }} Console or the My Account portal.
5357

5458
### User Signups
59+
5560
This graph in registration insights, represents the total number of successful user signups within the selected duration. You can view each day's signup count by hovering your mouse over a point on the graph.
5661

5762
![User signups graph]({{base_path}}/assets/img/guides/organization-insights/user-signups-graph.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
5863

64+
<!-- vale WSO2-IAM.SentenceStyleTitles = NO -->
65+
### Machine-to-Machine (M2M) authentications
66+
<!-- vale WSO2-IAM.SentenceStyleTitles = YES -->
67+
68+
This graph in M2M insights represents the number of new M2M tokens issued to your organization within the selected duration. By hovering your mouse over a point on the graph, you can view the specific count of M2M token requests for each day.
69+
70+
![M2M authentications graph]({{base_path}}/assets/img/guides/organization-insights/m2m-authentications-graph.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
71+
72+
!!! note
73+
This graph only tracks tokens issued via the [client credentials grant]({{base_path}}/references/grant-types/#client-credentials-grant). Reissued tokens are not counted.
74+
5975
## Filter insights
6076

61-
You can use filters to further narrow down insights related to login and registration activities.
77+
You can use filters to further narrow down insights related to login, registration, and M2M activities.
6278

6379
To filter insights,
6480

65-
1. On the {{ product_name }} Console, go to **Insights**, and select an activity (Login or Registration).
81+
1. On the {{ product_name }} Console, go to **Insights**, and select an activity (**Login**, **Registration**, or **M2M**).
6682

6783
2. Click the filter icon and use the following fields to filter insights .
6884

@@ -145,4 +161,18 @@ To filter insights,
145161
Example for a user ID: <code>1450ea7f-88db-49c2-b750-065e219a1fba</code>
146162
</td>
147163
</tr>
148-
</table>
164+
<tr>
165+
<td rowspan="2">M2M</td>
166+
<td>Client ID</td>
167+
<td>Filter M2M token requests based on the client ID of an M2M application in your organization.</br></br>
168+
(You can find the client ID of an application from the <b>Protocol</b> section of the application on the {{ product_name }} Console.)</br></br>
169+
Example for a client ID: <code>rXJ4z9k2mL8pQvN5wX1aB3</code>
170+
</td>
171+
</tr>
172+
<tr>
173+
<td>Organization</td>
174+
<td>Filter M2M token requests based on the organization.</br></br>
175+
You can search and select the organization from the dropdown list.
176+
</td>
177+
</tr>
178+
</table>

0 commit comments

Comments
 (0)