Page Views Analytics API
The Page Views analytics API endpoint gives you the same data that is found in the Page Views report and the Language report. This information provides visibility into who is consuming content, how, and from where. Use this information to make informed knowledge management and optimization decisions. Each row in the Page Views report represents an event.
API Endpoint: /@api/deki/site/analytics/pageviews?month=YYYY-MM
This will give you a result with the following data:
| Field Name | Description | Type | Example |
|---|---|---|---|
| ACCEPT_LANGUAGE | Language sent from the browser | STRING |
en-us en |
| ARTICLE_TYPE | The type of article at the time of the page view | STRING | howto |
| COMPATIBILITY_MODE | Used if the page was viewed in unsupported browsers | BOOLEAN | FALSE |
| CONTENT_LANGUAGE | Language the content was displayed in | STRING | en-us |
| EFFECTIVE_LANGUAGE | Page language | STRING |
en-us |
| 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 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 |
| IP_ADDRESS | The anonymized IP address of the page view | STRING | 34.232.239.0 |
| NEXT_PAGE_PATH | If available, the path of the page that the user goes to next | STRING | Admin/Contact/What_Version_of_CXone_Expert_Am_I_Using? |
| PAGE_ID | The ID of the page viewed, and the recommended page identifier | NUMBER | 13545 |
| PAGE_PATH | Path of the page at the time of the event, which can change over time and is not a recommended page identifier. | STRING | Admin/Branding/Branding_Guidelines/Logos_and_icons |
| PAGE_VIEW_ID | A unique identified for the page view | STRING | b272fe2e-8a79-48de-af4c-c33dc2417356 |
| PAGE_VIEW_WEB_WIDGET_REFERRER_EMBED_ID |
An identifier ID that the Expert team uses to see the type of Touchpoint (web widget) created in the Web Widgets section in Special:Integrations |
STRING | |
| PAGE_VIEW_WEB_WIDGET_REFERRER_EMBED_LOCATION |
An identifier ID that the Expert team uses to see where the Touchpoint is embedded |
STRING | |
| PAGE_VIEW_WEB_WIDGET_REFERRER_IS_INITIAL_REFERRAL |
An identifier ID that the Expert team uses, set to |
BOOLEAN |
TRUE FALSE |
| PAGE_VIEW_WEB_WIDGET_REFERRER_KEY | An identifier ID that the Expert team uses | STRING | |
| PAGE_VIEW_WEB_WIDGET_REFERRER_NAME |
The Touchpoint (Web Widget) created in the Web Widgets section in Special:Integrations For example, when you create a new F1 widget button |
STRING | |
| PAGE_VIEW_WEB_WIDGET_REFERRER_TYPE |
Web widgets do not send the origin parameter, so use the web widget type to infer which CRM integration was the source of the help request traffic. In addition, ensures that F1 web widgets are correctly attributed |
STRING | |
| PERCENT_VIEWED |
The maximum distance down the page a user has viewed, shown as a percent of the total page height (in pixels), also known as Scroll on Page |
NUMBER |
100 73 5 |
| PREV PAGE PATH | If available, the path of the page that the user was previously on | STRING | Admin/CXone_Expert_UI_overview/Administrative_pages/Control_Panel |
| REFERRER | If available, the webpage that sent the user to the page | STRING |
NULL |
| SECONDS_ON_PAGE | The number of seconds that a user was on a page | NUMBER |
30 0 |
| SECONDS_ON_PAGE_ESTIMATE | The number of seconds between consecutive page views within the same session | NUMBER |
48 5 |
| SESSION_ID | Indicates which events belong to which session | STRING | site_11706:efac2fe8-c43f-4e17-b5d7-081908ce7a77:1 |
| SESSION_NUMBER | Used to process sessions? | NUMBER | 1 |
| SESSION_REFERRAL_DOMAIN | The webpage that started the session that the page view is in | STRING |
www.google.com |
| SITE_ID | The unique ID for the site | STRING | site_11706 |
| TRANSLATED_LANGUAGE | The language that page content was translated into | STRING |
en-us |
| UA_IS_BOT |
Used to indicate if traffic was likely from a bot Exclude from results for most accurate reporting. |
BOOLEAN |
FALSE TRUE |
| USER_AGENT_ID | Identifies the unique user agent string from which the page view or browsing session originated | STRING | 305f2f0a3d87377fcbc6d9aa45e0235fe2fc9187 |
| 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 'Authenticated viewer' 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 |