Get logical requests
get
/serviceapi/apm.dataserver/api/v1/applications/{applicationName}/logicalServerRequests
Retrieve a list of logical requests.
Request
Supported Media Types
- application/json
Path Parameters
-
applicationName: string
Name of an application (see Get application definitions or similar). For more information about named path parameters see Object ID Parameters.
Query Parameters
-
aggregationPeriod(optional): integer(int32)
Aggregation period applied to time range between the
since
anduntil
parameters. This parameter's value is in 1-minute units. The default time series aggregation period is 60 minutes. Each bucket in the returned time series data represents the number of minutes in the aggregation period. See Time Series for more details. -
includeTimeseries(optional): boolean
Includes time series data if set to true
-
limit(optional): integer(int32)
Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
-
offset(optional): integer(int32)
Offset into result set at which to start returning data, useful for paging [default = 0].
-
orderBy(optional): string
Comma-separated list of one or more attributes by which the result set is ordered [default = null]. For more information see Sorting. Use
attribute
orattribute:asc
orattribute:desc
. Valid attributes can be found by using Get resource metadata withmetadataType
=OrderBy
andmetadataQuery
resource = -
q(optional): string
Query clause of one or more predicates to restrict the result set to those objects satisfying the clause [default = null]. For more information see Filtering. Use query like predicates, such as
attribute<=value< code>. Multiple predicates should be parenthesized and joined by
AND
orOR
. Valid attributes can be found by using Get resource metadata withmetadataType
=Filter
andmetadataQuery
resource = =value<> -
since: string
Retrieve results from start of time period, format
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
(e.g.2015-11-23T22:11:05.000Z
). For more information see Since and Until Time Range. -
until: string
Retrieve results until end of time period, format
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
Response
Supported Media Types
- application/json
200 Response
Completed successfully, list may be empty. See Status Codes for information about other possible HTTP response status codes.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object RequestType
Information about a Server Request (RequestType)
Nested Schema : RequestType
Type:
object
Information about a Server Request (RequestType)
Show Source
-
adminServerHost(optional):
string
-
adminServerPort(optional):
integer(int64)
-
agentName(optional):
string
-
appServerId(optional):
integer(int64)
-
appServerLongKey(optional):
string
-
appServerName(optional):
string
-
appServerPort(optional):
integer(int64)
-
appServerPortsList(optional):
string
-
appServerSslPort(optional):
integer(int64)
-
averageAppServerTime(optional):
number
-
averageDatabaseTime(optional):
number
-
averageExternalTime(optional):
number
-
averageResponseTime(optional):
number
-
averageSelfTime(optional):
number
-
completedCount(optional):
integer(int64)
-
deploymentName(optional):
string
-
errorPercentage(optional):
number
-
failureCount(optional):
integer(int64)
-
flowStart(optional):
boolean
Default Value:
false
-
hasCallerInfo(optional):
boolean
Default Value:
false
-
id(optional):
integer(int64)
-
linkCollection(optional):
array linkCollection
See Links to Related Resources for more information
-
loadRate(optional):
number
-
longKey(optional):
string
-
maxAppServerTime(optional):
integer(int64)
-
maxDatabaseTime(optional):
integer(int64)
-
maxExternalTime(optional):
integer(int64)
-
maxResponseTime(optional):
integer(int64)
-
maxSelfTime(optional):
integer(int64)
-
meId(optional):
string
-
minAppServerTime(optional):
integer(int64)
-
minDatabaseTime(optional):
integer(int64)
-
minExternalTime(optional):
integer(int64)
-
minResponseTime(optional):
integer(int64)
-
minSelfTime(optional):
integer(int64)
-
operationGenre(optional):
string
-
operationName(optional):
string
-
queryTimeRange(optional):
object TimeRange
-
requestId(optional):
integer(int64)
-
serverName(optional):
string
-
totalAppServerTime(optional):
integer(int64)
-
totalDatabaseTime(optional):
integer(int64)
-
totalExternalTime(optional):
integer(int64)
-
totalResponseTime(optional):
integer(int64)
-
totalSelfTime(optional):
integer(int64)
-
warnings(optional):
array warnings
Informational or Error messages
Nested Schema : linkCollection
Type:
array
See Links to Related Resources for more information
Show Source
-
Array of:
object Link
Information about a Link to a resource
Nested Schema : TimeRange
Type:
Show Source
object
-
sinceTime(optional):
integer(int64)
Results are returned *since* this timestamp
-
timeInMinutes(optional):
integer(int64)
-
untilTime(optional):
integer(int64)
Results are returned *until* this timestamp
Nested Schema : warnings
Type:
array
Informational or Error messages
Show Source
-
Array of:
object ErrorMessage
An error message
Nested Schema : Link
Type:
object
Information about a Link to a resource
Show Source
-
baseUrl(optional):
string
The base URL for the link
-
href:
string
The href portion of the link
-
post(optional):
string
The post data of the link
-
rel:
string
The relationship name of the link
Nested Schema : ErrorMessage
Type:
object
An error message
Show Source
-
detail:
string
A detailed description of the error
-
errorType(optional):
string
Allowed Values:
[ "INFO", "WARNING", "VALIDATION", "ERROR" ]
The error type -
message:
string
The error message