Path Events Analytics API
The Path Events report makes the underlying events data powering the Path Completion report available via API. This information helps you understand user engagement within your Expert Paths. Each row in the report represents an event.
API Endpoint: /@api/deki/site/analytics/pathevents?month=YYYY-MM
The following is a description for each column in the resulting file, the column's data type, and example records:
| Name | Description | Type | Example |
|---|---|---|---|
| ACTIVITY_SESSION_ID | Indicates which events belong to which session | STRING | site_11706:b7226070-0397-4fb9-ba10-bf13fde13ea4:2 |
| 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 |
| EVENT_DATETIME | The date and time the event occurred |
TIMESTAMP_LTZ(0) Format: YYYY-MM-DD HH:MM:ss.mmm Z |
2023-06-01 23:57:06.000 Z |
| EVENT_ID | A unique identifier for page views events. A count of this ID should match the "Page Views" metric in the Dashboard. | STRING | 03472928-00d8-11ee-a869-719f334a7d1d |
| IS_COMPLETE | True if the total pages viewed in the session is equal to total pages | BOOLEAN |
TRUE FALSE |
| IS_DUPLICATE | True if a particular page is viewed more than once | BOOLEAN |
TRUE FALSE |
| IS_IN_ORDER | True if the page number is equal to the view order | BOOLEAN |
TRUE FALSE |
| PAGE_NAME | The title of the page | VARIANT |
"Create_a_Learning_Path" "What_is_an_identity_provider" |
| PAGE_NUMBER | The page's index in the path | NUMBER |
1 4 |
| PAGE_PATH | Path of the page at the time of the event. This can change over time, and is not a recommended page identifier. | STRING | Admin/Branding/Branding_Guidelines/Logos_and_icons |
| PATH_KEY | A concatenation of PATH_TITLE and PATH_VERSION values | STRING | |
| PATH_NAME | The name of the learning path | STRING |
training-information_architecture learning_path_ProductX |
| PATH_TITLE | The title of the path as it appears to users | STRING |
Create an Expert Path |
| PATH_VERSION | The last time the path was modified / updated |
TIMESTAMP Format: YYYY-MM-DD HH:MM:ss.mmm Z |
2024-01-03 20:24:18.000 Z |
| SESSION_ID | Indicates which events belong to which session | STRING | site_11706:efac2fe8-c43f-4e17-b5d7-081908ce7a77:1 |
| SITE_ID | The unique ID for the site | STRING | site_11706 |
| TOTAL_PAGES | The total number of pages in the path | NUMBER | 8 |
| TOTAL_VIEWED | The number of pages in the path that were viewed | NUMBER | 5 |
| 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 |
| VIEW_ORDER | The order the page was viewed, regardless of its place in the path | NUMBER | 1 |