Get pages
get
/serviceapi/apm.dataserver/api/v1/pages
Retrieve a list of pages. For more information see Pages and Ajax Calls.
Request
Supported Media Types
- application/json
Query Parameters
-
includePageupdate(optional): string
Set to true to include Page Update items [default = false]Default Value:
false
-
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 =/pages
-
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 =/pages
=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 PageType
Information about a Page (PageType, including PageUpdate)
Nested Schema : PageType
Type:
object
Information about a Page (PageType, including PageUpdate)
Show Source
-
apdex(optional):
number
-
attr1(optional):
string
-
attr2(optional):
string
-
averageFirstByteTime(optional):
number
-
averageInteractiveTime(optional):
number
-
averageResponseTime(optional):
number
-
completedCount(optional):
integer(int64)
-
contextId(optional):
string
-
dataSource(optional):
integer(int32)
-
dimAttr1Id(optional):
integer(int64)
-
dimAttr2Id(optional):
integer(int64)
-
dimPageId(optional):
integer(int64)
-
errorPercentage(optional):
number
-
failureCount(optional):
integer(int64)
-
frustratedPercentage(optional):
number
-
id(optional):
integer(int64)
-
linkCollection(optional):
array linkCollection
See Links to Related Resources for more information
-
loadRate(optional):
number
-
longKey(optional):
string
-
longKeyOld(optional):
string
-
maxFirstByteTime(optional):
integer(int64)
-
maxInteractiveTime(optional):
integer(int64)
-
maxResponseTime(optional):
integer(int64)
-
meId(optional):
string
-
minFirstByteTime(optional):
integer(int64)
-
minInteractiveTime(optional):
integer(int64)
-
minResponseTime(optional):
integer(int64)
-
mobileAppCount(optional):
integer(int32)
-
pageId(optional):
integer(int64)
-
pageIdOld(optional):
integer(int64)
-
pageTitle(optional):
string
-
pageUrl(optional):
string
-
queryTimeRange(optional):
object TimeRange
-
satisfiedPercentage(optional):
number
-
tenantId(optional):
integer(int64)
-
toleratingPercentage(optional):
number
-
totalFirstByteTime(optional):
integer(int64)
-
totalInteractiveTime(optional):
integer(int64)
-
totalResponseTime(optional):
integer(int64)
-
updateType(optional):
string
-
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