Retrieving business transaction data

The GET method of the Business Transactions API retrieves data from business transactions of application servers that are monitored by App Visibility Manager. The data is similar to what you might see on the Business Transactions page for application monitoring.

The API contains the following topics:

API overview

Method—GET

Request parameters—time (from, to), topLevelOnly, entryPoint, serverId, application, dbId

API registration

Use the following URL to register the API:

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

Replace the following entries, as required:

EntryDescription
httpsProtocol used to send the request
portalHostHost 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

Use this API to retrieve data about transactions and requests.

EntryDescriptionMandatory
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
topLevelOnly

Response contains only the top-level request (Transaction type)

See Analyzing business transactions for details about transaction types.

The default value is false.

No

entryPoint

One or more entry points by which to limit the response

Example: entryPoint=entryPointName1&entryPoint=entryPointName2

No
serverId

One or more server IDs by which to limit the response

The serverId is an identifying string (automatically assigned) of the server.

Example: serverId=id1&serverId=id2&serverId=id3

No
application

Application ID by which to limit the response

The application ID is an identifying string (automatically assigned) of the application.

No
dbId

Database ID by which to limit the response

The dbId parameter requires the application parameter.

No

URL example

https://my-portal-33:8100/portal/rest/fragments/metrics?from=1441698600000&to=9999999999999&application=D1C09D70

Sample JSON response

Response content

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

ObjectDescription
applicationIDIdentifying string (automatically assigned) of the application
entryPointName

Name of the entry point

metrics.W_S.avgValue

Average value, in milliseconds, of the web service metrics

metrics.REQUEST_DURATION

  • maxValue
  • avgValue

Duration of the request, in milliseconds: maximum and average values

metrics.WEB.avgValue

Average value, in milliseconds, of the web tier
metrics.REQUEST_GOOD_COUNT.countNumber of transactions without errors or latency violations
metrics.REQUEST_VIOLATION_DURATION.countNumber of transactions with latency violations
metrics.REQUEST_COUNT.count

Total number of transaction hits

metrics.REQUEST_VIOLATION_ERROR.countNumber of transactions with errors
durationDuration, in milliseconds, of the time period, calculate from the values you entered

Related topics

Using APIs to generate report data for App Visibility Manager

Analyzing business transactions

Was this page helpful? Yes No Submitting... Thank you

Comments