The KCS Events analytics API endpoint gives you the data that you would find in the Capture Manager report. This information allows you to monitor high-level Capture Manager usage among agents across your Expert site. Each row in the report represents an event. This data can be requested by month, week or day. A 48 hour data settling period is required in order to ensure the API call captures all data for the requested time frame. For example, data for 4/22 should be requested on 4/24. If called sooner, data will be retrieved but it may not include all events.
API Endpoints:
/@api/deki/site/analytics/kcsevents?month=YYYY-MM/@api/deki/site/analytics/kcsevents?YYYY-MM-W (W= week of month. For example, first week of month W = 1)/@api/deki/site/analytics/kcsevents?day=YYYY-MM-DDThis will give you a result with the following data:
| Name | Description | Type | Example |
|---|---|---|---|
| EVENT_DATE |
The date the event occurred Data is stored in UTC |
DATE (M/D/YYYY) |
6/1/2023 12/22/2023 |
| 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 |
| EVENT_TYPE |
|
page.kcs:confidence.changed page.kcs:flag page.kcs:visibility.changed page.kcs:unflag page.kcs:governance.changed page.kcs:flag page.kcs:visibility.changed page.kcs:unflag page.kcs:governance.changed |
|
| 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 |
| 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 |
| USER_ID |
The user who viewed the page. A user ID of 1 indicates that the user was Anonymous. |
NUMBER | 756 |