Jump to

• Request
• Response

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 and until 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 and metadataQuery resource = /pages
• information(optional): string
  Comma-separated list of informational settings used during baselines processing. Valid values are analytics, settings and timings.
• 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'

Back to Top

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.

Body ()

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

{
    "type":"object",
    "properties":{
        "averageResponseTimeBaselines":{
            "$ref":"#/definitions/BaselinesAttributeData"
        },
        "completedCountBaselines":{
            "$ref":"#/definitions/BaselinesAttributeData"
        },
        "errorPercentageBaselines":{
            "$ref":"#/definitions/BaselinesAttributeData"
        },
        "apdexBaselines":{
            "$ref":"#/definitions/BaselinesAttributeData"
        },
        "settings":{
            "type":"string"
        },
        "timeSeries":{
            "$ref":"#/definitions/GraphDataArray"
        },
        "timings":{
            "type":"string"
        },
        "linkCollection":{
            "type":"array",
            "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "queryTimeRange":{
            "description":"Integer query time range used by server to run user query; see <a href='QP_Since_and_Until_Time_Range.html'>Since and Until Time Range</a> for more information",
            "$ref":"#/definitions/TimeRange"
        },
        "warnings":{
            "type":"array",
            "description":"Informational or Error messages",
            "items":{
                "$ref":"#/definitions/ErrorMessage"
            }
        }
    },
    "description":"Baselines metric data for a Page (PageBaselinesData)"
}

Nested Schema : BaselinesAttributeData

Type: object

Baselines data for a specific attribute (BaselinesAttributeData)

Show Source

• analytics(optional): object Analytics
• anomalyHighCount(optional): array anomalyHighCount
• anomalyLowCount(optional): array anomalyLowCount
• baselinesHigh(optional): array baselinesHigh
• baselinesLow(optional): array baselinesLow

{
    "type":"object",
    "properties":{
        "baselinesHigh":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "anomalyHighCount":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "baselinesLow":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "anomalyLowCount":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "analytics":{
            "$ref":"#/definitions/Analytics"
        }
    },
    "description":"Baselines data for a specific attribute (BaselinesAttributeData)"
}

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

{
    "type":"array",
    "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeRange

Type: object

Show Source

• sinceTime(optional): integer(int64)
  Results are returned *since* this timestamp
• timeInMinutes(optional): integer(int64)
• untilTime(optional): integer(int64)
  Results are returned *until* this timestamp

{
    "type":"object",
    "properties":{
        "timeInMinutes":{
            "type":"integer",
            "format":"int64"
        },
        "sinceTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *since* this timestamp"
        },
        "untilTime":{
            "type":"integer",
            "format":"int64",
            "description":"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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "longKey":{
            "type":"string"
        },
        "totalTime":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "minResponseTime":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "maxResponseTime":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "completedCount":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "failureCount":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "averageResponseTime":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "formattedTime":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lengthMin":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "bucket":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "timeFormatter":{
            "$ref":"#/definitions/ITimeFormatter"
        },
        "time":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "linkCollection":{
            "type":"array",
            "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "queryTimeRange":{
            "description":"Integer query time range used by server to run user query; see <a href='QP_Since_and_Until_Time_Range.html'>Since and Until Time Range</a> for more information",
            "$ref":"#/definitions/TimeRange"
        },
        "warnings":{
            "type":"array",
            "description":"Informational or Error messages",
            "items":{
                "$ref":"#/definitions/ErrorMessage"
            }
        }
    },
    "description":"Information about a Time Series Graph (GraphDataArray)",
    "xml":{
        "name":"graphDataAsArray"
    }
}

Nested Schema : warnings

Type: array

Informational or Error messages

Show Source

• Array of: object ErrorMessage
  An error message

{
    "type":"array",
    "description":"Informational or Error messages",
    "items":{
        "$ref":"#/definitions/ErrorMessage"
    }
}

Nested Schema : Analytics

Type: object

Show Source

• callerSince(optional): string
• elapsedTime(optional): integer(int64)
• forecastCount(optional): integer(int32)
• forecastSince(optional): string
• forecastUntil(optional): string
• input(optional): object input
• output(optional): object output
• trainingCount(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "forecastCount":{
            "type":"integer",
            "format":"int32"
        },
        "forecastSince":{
            "type":"string"
        },
        "forecastUntil":{
            "type":"string"
        },
        "callerSince":{
            "type":"string"
        },
        "trainingCount":{
            "type":"integer",
            "format":"int32"
        },
        "elapsedTime":{
            "type":"integer",
            "format":"int64"
        },
        "input":{
            "type":"object"
        },
        "output":{
            "type":"object"
        }
    }
}

Nested Schema : anomalyHighCount

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : anomalyLowCount

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : baselinesHigh

Type: array

Show Source

• Array of: number

{
    "type":"array",
    "items":{
        "type":"number"
    }
}

Nested Schema : baselinesLow

Type: array

Show Source

• Array of: number

{
    "type":"array",
    "items":{
        "type":"number"
    }
}

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

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship name of the link"
        },
        "href":{
            "type":"string",
            "description":"The href portion of the link"
        },
        "baseUrl":{
            "type":"string",
            "description":"The base URL for the link"
        },
        "post":{
            "type":"string",
            "description":"The post data of the link"
        }
    },
    "description":"Information about a Link to a resource"
}

Nested Schema : averageResponseTime

Type: array

Show Source

• Array of: number

{
    "type":"array",
    "items":{
        "type":"number"
    }
}

Nested Schema : bucket

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : completedCount

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : failureCount

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : formattedTime

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : lengthMin

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

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

{
    "type":"array",
    "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : maxResponseTime

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : minResponseTime

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : time

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : ITimeFormatter

Type: object

Nested Schema : totalTime

Type: array

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : warnings

Type: array

Informational or Error messages

Show Source

• Array of: object ErrorMessage
  An error message

{
    "type":"array",
    "description":"Informational or Error messages",
    "items":{
        "$ref":"#/definitions/ErrorMessage"
    }
}

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

{
    "type":"object",
    "required":[
        "detail",
        "message"
    ],
    "properties":{
        "errorType":{
            "type":"string",
            "description":"The error type",
            "enum":[
                "INFO",
                "WARNING",
                "VALIDATION",
                "ERROR"
            ]
        },
        "message":{
            "type":"string",
            "description":"The error message"
        },
        "detail":{
            "type":"string",
            "description":"A detailed description of the error"
        }
    },
    "description":"An error message"
}

Back to Top