Retrieving user transaction data

The GET method of the User Transactions API retrieves data about page users and page metrics, such as user transaction data from App Visibility Manager's end-user monitoring.

The API contains the following topics:

API overview

Method—GET

Request parameters—time (from, to), application

API registration

Use the following URLs to register the API:

https://portalHost:portalPort/portal/rest/pages/users

https://portalHost:portalPort/portal/rest/pages/metrics

Replace the following entries, as required:

Entry Description

https Protocol used to send the request

portalHost Host name or IP address of the App Visibility portal

portalPort

Communication port number of the App Visibility portal.

The default port number is 8100.

Request parameters

Entry Description Mandatory

from

Epoch time stamp in milliseconds from which to start the data collection

Use a time stamp converter, such as http://www.epochconverter.com/, to generate the value.

Yes

to

Epoch time stamp in milliseconds from which to end the data collection

Use a time stamp converter, such as http://www.epochconverter.com/, to generate the value.

Yes

application Identifying string (automatically assigned) of an application Yes

Examples and responses for page users

URL example for page users

https://clm-pun-014433:8100/portal/rest/pages/users?from=1441618500000&to=1441618800000&application=15D911C3

Sample JSON response for page users

Response content for page users

Object	Description
requestName	Name of the request
errorUsers	Percentage of users that experience availability issues
latencyUsers	Percentage of users that experience performance issues, exceeding the E2E time threshold for the application
totalUserCount	Total number of users for the specified time range
entryPointType	Type of request: PAGE, AJAX, BT (business transaction), EXTERNAL_SERVICE

Examples and responses for page metrics

URL example for page metrics

https://clm-pun-014433:8100/portal/rest/pages/metrics?from=1441611600000&to=1441611900000&application=15D911C3

Sample JSON response for page metrics

Response content for page metrics

Only the specified object is applicable. Other objects are for internal use.

Object	Description
requestName	Name of the user request
PAGE_SERVER_LATENCY.avgValue	Average latency, in milliseconds, of all the backend servers, such as web servers, business application servers, and databases
PAGE_NETWORK_COUNT.count	Number of web pages where network time calculations are possible
PAGE_GOOD_COUNT.count	Number of web pages requests that do not have errors or latency violations
PAGE_NETWORK_LATENCY.avgValue	Average network latency, in milliseconds
PAGE_ERROR_VIOLATION.count	Number of web page requests that have errors
PAGE_SERVER_COUNT.count	Number of servers where server time calculations are possible
PAGE_LATENCY maxValue avgValue	Average and maximum values of web page latency, in milliseconds
PAGE_COUNT.count	Total number of web page requests
PAGE_LATENCY_VIOLATION.count	Number of web pages requests that have latency violations

Page tree