SNAnalytics - Client
-
- UpdatedJan 30, 2025
- 6 minutes to read
- Yokohama
- API reference
The SNAnalytics API provides methods to push custom analytics data (events, pages, and user properties) to the User Experience Analytics for Service Portal dashboard.
User Experience Analytics for Service Portal provides dashboard views for monitoring the key performance indicators (KPIs) of web applications built on Service Portal. You can use these insights to optimize your portal. For example, User Experience Analytics tracks when a user orders a catalog item or views a knowledge article. You can use this data to infer which items or articles are the most popular among users.
To access this API, the Service Portal Analytics (com.glide.service-portal.analytics) plugin must be activated on the instance. In addition, within your application, you must import the snAnalytics Angular service, such as:
For additional information, see User Experience Analytics for Service Portal.
SNAnalytics - addEvent(Object payload)
Stores the specified event information in the analytics data store.
Events are actions performed by a user, such as clicking a button or submitting a form. Call this method within your web-page widget whenever you want to capture a user action. These events then automatically appear on the associated user session timeline and User Experience Analytics dashboard.
The screen capture below shows the information that appears on the analytics dashboard for
the event "Manage Account." The timeline at the top represents the number of times that the
event occurred. The pie charts below the timeline reflect the properties that were captured
in the addEvent() call.
If you want to capture when users access a web page, use the SNAnalytics - startPage(String name, String description) method instead of this method.
Name | Type | Description |
---|---|---|
payload | Object | Event to store in the analytics data store. Data type: Object |
payload.data | Array Each element can be a string (case-sensitive), boolean, number, or date. |
Optional. Name-value pairs of custom event properties. These properties can be any values that you want to track and see on the analytics dashboard. They appear under the associated event timeline on the
analytics dashboard. The Page Id property always appears first on the dashboard for all base system events, and all other properties are sorted alphabetically. If no properties are required for an event, only an event timeline appears on the analytics dashboard. Properties can be added at a later time. The following values are automatically converted by this
method:
Default value: Null |
payload.name | String | Descriptive name of the event. Special characters are not allowed. Maximum length: The length of the event name and value cannot exceed 300 bytes. |
Type | Description |
---|---|
None |
Example
The following example shows how to call the addEvent() method during initialization of a widget.
SNAnalytics - appendToUserProperty(String name, String value)
Appends the specified string to the specified user string property in the analytics data store.
Name | Type | Description |
---|---|---|
name | String or String[] | Name of the property to append the specified string to. Special characters are not allowed. Note: The associated property must be a string or string[].
Maximum length: The length of the property name and property value cannot exceed 300 bytes. |
value | String | Value to append to the string property. The following values are automatically converted by this
method:
|
Type | Description |
---|---|
None |
Example
This example shows how to add television to the tags
property.
SNAnalytics - incUserProperty(String name, Number value)
Increments or decrements the specified user property value with the specified number value in the analytics data store.
Name | Type | Description |
---|---|---|
name | String | Name of the property to increment. Value is case-sensitive. Note: The associated
property must be a number. |
value | Number | Amount to increment the property by. If you enter a negative number, the value is decremented. |
Type | Description |
---|---|
None |
Example
The following example shows how to increment the property Grace days
by
5.
SNAnalytics - removeUserProperty(String name)
Removes the specified property for the current user from the analytics data store.
In addition, the property no longer appears on the analytics dashboard.
Name | Type | Description |
---|---|---|
name | String | Name of the property to remove. Value is case-sensitive. |
Type | Description |
---|---|
None |
Example
The following example shows how to remove the IsAdmin property.
SNAnalytics - setUserProperties(Object properties)
Sets the specified properties with the specified values for the current user in the analytics data store.
These properties are saved in the analytics data store and appear on the user session details page as illustrated below. If a property already exists in the analytics data store, the current value is overwritten with the new value.
Name | Type | Description |
---|---|---|
properties | Object Each element in this object can be a string, boolean, number, date, string[], or null. |
Object that contains the name-value pairs of the user properties to set, such as: The following values are automatically converted by this
method:
|
Type | Description |
---|---|
None |
Example
The following example shows how to set multiple properties for the current user.
SNAnalytics - setUserProperty(String name, UserProperty value)
Sets the specified property with the specified value for the current user in the analytics data store.
These properties are saved in the analytics data store and appear on the user session details page as illustrated below. If a property already exists in the analytics data store, the current value is overwritten with the new value.
Name | Type | Description |
---|---|---|
name | String | Name of the property to update. This name appears as the label for the property. For example, in the prior screenshot, Domain, Instance Name, Company, Role, and User Type are all name parameters. Special
characters are not allowed. Maximum length: The length of the property name and property value cannot exceed 300 bytes. |
value | UserProperty This value can be a string, boolean, number, date, string[], or null. |
Value to set in the specified property. The following values are automatically converted by this
method:
|
Type | Description |
---|---|
None |
Example
The following example shows how to set the property Company
.
SNAnalytics - startPage(String name, String description)
Saves the name and description of a page in the analytics data store.
Name | Type | Description |
---|---|---|
name | String | Descriptive name of the page or page section. Special characters are not allowed. |
description | String | Optional. Description of the page to appear in the timeline and analytics
dashboard. Default: name parameter value |
Type | Description |
---|---|
None |
Example
The following example shows how to call the startPage() method.
On this page
- SNAnalytics - addEvent(Object payload)
- SNAnalytics - appendToUserProperty(String name, String value)
- SNAnalytics - incUserProperty(String name, Number value)
- SNAnalytics - removeUserProperty(String name)
- SNAnalytics - setUserProperties(Object properties)
- SNAnalytics - setUserProperty(String name, UserProperty value)
- SNAnalytics - startPage(String name, String description)