Skip to main content
NICE CXone Expert

We will be closed on Monday, May 27th in observance of Memorial Day

Expert Success Center

Page View Sessions Analytics API

The Page Views Sessions analytics API endpoint gives you the data that you would find in the Self-Service report. This information can help you understand how your content is performing, so you can make targeted improvements. Each row in the report represents an event.

Every page view event is recorded in the Page Views report. The Page Views Sessions endpoint breaks the page views into sessions, so multiple page views can be grouped together. Each session is an event.

API endpoint: /@api/deki/site/analytics/pageviewsessions?month=YYYY-MM

This will give you a result with the following data:

Name Description Type Example
ACCEPT_LANGUAGE The language sent from the browser STRING

en-us

en

CONTENT_LANGUAGE The language the content was displayed in STRING en-us
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_ID The ID of the first page viewed in the session, 
and the recommended page identifier
NUMBER 103
FIRST_PAGE_PATH The page path of the first page in the session STRING Manage/Content_Maintenance/Subscriptions_and_Notifications
IDENTIFIER An identifier ID that the Expert team uses STRING site_11706cca77dfd-9f86-49e4-bb5b-ab51bae397d8
INVALID An alert for the Expert team BOOLEAN

TRUE

FALSE

IP_ADDRESS The anonymized IP address of the page view STRING 34.232.239.0
LAST_ARTICLE_TYPE The article type of the final article in the session STRING

howto

topic-category

LAST_PAGE_ID The ID of the last page viewed in the session, 
and the recommended page identifier
NUMBER 1522
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 total page views in the session NUMBER 4
NUM_UNIQUE_PAGE_VIEWS Number of unique page views in a session NUMBER 2
REFERRER If available, the webpage that sent the user to the page. STRING

NULL

https://success.mindtouch.com/Admin/Release_Notes

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

NULL

www.google.com

SITE_ID The unique ID for the site 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
TOTAL_SECONDS_ON_PAGE The amount of time in seconds the user spent on the page NUMBER 310
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 '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

 

  • Was this article helpful?