Jump to

• Request
• Response

Get request summary information for an application server ID

get

/serviceapi/apm.dataserver/api/v1/appservers/{appserverId}/requestSummary

Retrieve request summary information for an application server ID. For more information see Server Requests.

Request

Supported Media Types

• application/json

Path Parameters

• appserverId: string
  ID of application server (see Get application servers and their JVM metrics or similar). For more information see Object ID Parameters.

Query Parameters

• 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 : AppServerRequestSummary

Type: object

Request summary for an App Server (AppServerRequestSummary)

Show Source

• appServerId(optional): integer(int64)
• averageResponseTime(optional): number
• completedCount(optional): integer(int64)
• errorPercentage(optional): number
• errorRate(optional): number
• failureCount(optional): integer(int64)
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• loadRate(optional): number
• longKey(optional): string
• maxResponseTime(optional): integer(int64)
• minResponseTime(optional): integer(int64)
• queryTimeRange(optional): object TimeRange
• totalResponseTime(optional): integer(int64)
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "errorPercentage":{
            "type":"number"
        },
        "loadRate":{
            "type":"number"
        },
        "minResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "appServerId":{
            "type":"integer",
            "format":"int64"
        },
        "longKey":{
            "type":"string"
        },
        "completedCount":{
            "type":"integer",
            "format":"int64"
        },
        "failureCount":{
            "type":"integer",
            "format":"int64"
        },
        "totalResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "averageResponseTime":{
            "type":"number"
        },
        "errorRate":{
            "type":"number"
        },
        "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":"Request summary for an App Server (AppServerRequestSummary)"
}

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 : 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 : 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 : 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