Get baseline and anomaly data for a page
get
/serviceapi/apm.dataserver/api/v1/pages/{id}/baselines
Retrieve the baseline and anomaly data for a known page ID. For more information see Baselines and Anomalies overview.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of page (see Get pages, Get browser callers for a request ID or similar). For more information see Object ID Parameters.
Query Parameters
-
aggregationPeriod: integer(int32)
Aggregation period applied to time range between the
since
anduntil
parameters. This parameter's value is in 1-minute units. Each bucket in the returned baseline and anomaly data represents the number of minutes in the aggregation period. See Baselines and Anomalies for more details. -
attributes: string
Comma-separated list used to identify the metric attributes for which baseline measurements and anomalies are being retrieved. Valid attributes can be found by using Get resource metadata with
metadataType
=Baselines
andmetadataQuery
resource =/pages
-
information(optional): string
Comma-separated list of informational settings used during baselines processing. Valid values are
analytics
,settings
andtimings
. -
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, result may be null. See Status Codes for information about other possible HTTP response status codes.
Root Schema : PageBaselinesData
Type:
object
Baselines metric data for a Page (PageBaselinesData)
Show Source
-
apdexBaselines(optional):
object BaselinesAttributeData
Baselines data for a specific attribute (BaselinesAttributeData)
-
averageResponseTimeBaselines(optional):
object BaselinesAttributeData
Baselines data for a specific attribute (BaselinesAttributeData)
-
completedCountBaselines(optional):
object BaselinesAttributeData
Baselines data for a specific attribute (BaselinesAttributeData)
-
errorPercentageBaselines(optional):
object BaselinesAttributeData
Baselines data for a specific attribute (BaselinesAttributeData)
-
linkCollection(optional):
array linkCollection
See Links to Related Resources for more information
-
queryTimeRange(optional):
object TimeRange
-
settings(optional):
string
-
timeSeries(optional):
object graphDataAsArray
Information about a Time Series Graph (GraphDataArray)
-
timings(optional):
string
-
warnings(optional):
array warnings
Informational or Error messages
Nested Schema : BaselinesAttributeData
Type:
object
Baselines data for a specific attribute (BaselinesAttributeData)
Show Source
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 : graphDataAsArray
Type:
object
Information about a Time Series Graph (GraphDataArray)
Show Source
-
averageResponseTime(optional):
array averageResponseTime
-
bucket(optional):
array bucket
-
completedCount(optional):
array completedCount
-
count(optional):
integer(int32)
-
failureCount(optional):
array failureCount
-
formattedTime(optional):
array formattedTime
-
id(optional):
integer(int64)
-
lengthMin(optional):
array lengthMin
-
linkCollection(optional):
array linkCollection
See Links to Related Resources for more information
-
longKey(optional):
string
-
maxResponseTime(optional):
array maxResponseTime
-
minResponseTime(optional):
array minResponseTime
-
queryTimeRange(optional):
object TimeRange
-
time(optional):
array time
-
timeFormatter(optional):
object ITimeFormatter
-
totalTime(optional):
array totalTime
-
warnings(optional):
array warnings
Informational or Error messages
Nested Schema : warnings
Type:
array
Informational or Error messages
Show Source
-
Array of:
object ErrorMessage
An error message
Nested Schema : input
Type:
object
Nested Schema : output
Type:
object
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 : 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 : ITimeFormatter
Type:
object
Nested Schema : warnings
Type:
array
Informational or Error messages
Show Source
-
Array of:
object ErrorMessage
An error message
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