User Engagement Analytics API
The User Engagement analytics API endpoint gives you data that you would find in the Traffic Insights report. This information provides helpful data for you to discover what types of traffic arrives at your site, the origins of that traffic, and how visitors are accessing your site. Each row in the report represents an event.
API endpoint: /@api/deki/site/analytics/userengagement?month=YYYY-MM
This will give you a result with the following data:
| Name | Description | Type | Example |
|---|---|---|---|
| ACCEPT_LANGUAGE | Language sent from the browser | STRING |
en-us en |
| BROWSER | The internet browser being used | STRING |
Chrome Safari |
| COUNTRY_ISO_CODE | The country's ISO code | STRING |
US FR |
| COUNTRY_NAME | The name of the country | STRING |
United States France |
| DEVICE | The device being used | STRING |
mobile PC |
| END_DATETIME | The date and time when the session ended |
TIMESTAMP Format: YYYY-MM-DD HH:MM:ss.mmm Z |
2023-06-01 23:57:06.000 Z |
| ENGAGEMENT_CHANNEL | The method of delivery a visitor uses to access knowledge content. This can include options such as direct, referral, Touchpoints, or support channels. | STRING |
direct search referral |
| EVENT_DATE | The date the event occurred | DATE (M/D/YYYY) | 6/1/2023
12/22/2023 |
| FIRST_ARTICLE_TYPE | The page type of the first page in the session | STRING |
howto topic-category |
| FIRST_PAGE_PATH | The page path of the first page in the session | STRING | Manage/Content_Maintenance/Subscriptions_and_Notifications |
| GROUP_END_DATETIME | The end date / time of user membership within a specific group |
TIMESTAMP Format: YYYY-MM-DD HH:MM:ss.mmm Z |
2023-06-01 23:57:06.000 Z |
| GROUP_ID | An identifier for a particular group | NUMBER |
23 |
| GROUP_START_DATETIME | The start date / time of user membership within a specific group |
TIMESTAMP Format: YYYY-MM-DD HH:MM:ss.mmm Z |
2023-06-01 23:57:06.000 Z |
| IDENTIFIER | An identifier ID that the Expert team uses | STRING | site_11706d4b6d20c-2804-4f88-8a64-230fa37f7e07 |
| INVALID | An identifier the Expert team uses | BOOLEAN |
FALSE TRUE |
| IS_INTERNAL_REQUEST | An identifier the Expert team uses to classify requests | BOOLEAN |
FALSE TRUE |
| LAST_ARTICLE_TYPE | The page type of the final article in the session | STRING |
howto topic-category |
| LAST_PAGE_PATH | The path of the last page in the session | STRING | Manage/Content_Maintenance/Subscriptions_and_Notifications |
| NUM_PAGE_VIEWS | The number of pages viewed in a particular session | NUMBER |
1 |
| REFERRING_URL | An identifier the Expert team uses to recognize the referrer or web widget location | STRING | |
| SEARCH_DOMAIN | The name of the search engine's domain | BOOLEAN |
TRUS FALSE |
| SESSION_AND_GROUP | The concatenation of the Session ID and Group ID | STRING | site_11706:103a5e59-3061-457b-b468-9762efa58226:1:114 |
| SESSION_EVENTS | A list of events in a particular session | OBJECT |
{"page:view":1} {"search:index":1} |
| SESSION_ID | Indicates which events belong to which session | STRING | site_11706:efac2fe8-c43f-4e17-b5d7-081908ce7a77:1 |
| SESSION_NUMBER | A number calculated based on whether the period of inactivity prior to the current event was greater than the cutoff | NUMBER | 1 |
| SESSION_REFERRAL_DOMAIN | The referring domain of the page view, if applicable. | STRING |
www.google.com |
| SITE_ID | The site where the event occurred | STRING | site_11706 |
| START_DATETIME | When the session began |
TIMESTAMP Format: YYYY-MM-DD HH:MM:ss.mmm Z |
2023-06-01 23:57:06.000 Z |
| UA_IS_BOT |
Used to indicate if traffic was likely from a bot. Exclude from results for most accurate reporting. |
BOOLEAN |
FALSE TRUE |
| USER_ID |
The user who viewed the page. A user ID of 1 indicates that the user was Anonymous. |
NUMBER | 756 |
| USER_IS_ANONYMOUS |
Used in combination with 'USER_IS_SEATED' to determine if the user is a Viewer or Seated user. Anonymous, non-seated users are 'Anonymous'. Non-anonymous, non-seated users are 'Community' users. Seated users are always non-anonymous. If this value is TRUE, the USER_IS_SEATED value should be FALSE. |
BOOLEAN |
FALSE TRUE |
| USER_IS_SEATED |
Used in combination with 'USER_IS_ANONYMOUS' to determine if the user is a Viewer or Seated user. If this value is TRUE, the USER_IS_ANONYMOUS value should be FALSE. |
BOOLEAN |
TRUE FALSE |
| USER_TYPE | The user type of the person viewing the site | STRING |
Anonymous Community Member Pro Member |