Jump to

• Request
• Response

Get web-application metrics

get

/serviceapi/apm.dataserver/api/v1/webApps/getMetrics

Retrieve a list of monitored web-application metrics.

Request

Query Parameters

• appName(optional): string
  Specifies the name of the application to query.
• filters(optional): string
  Specifies the attribute(s), operator and value, to filter on. For more information see the "filters" parameter.
• limit(optional): integer(int32)
  Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
• 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.
• sortBy(optional): string
  Specifies the name of the attribute to order the resultset by.
• sortDir(optional): string
  Specifies the sort-direction ('asc' or 'desc'), default is ascending.
• 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, list may be empty. See Status Codes for information about other possible HTTP response status codes.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object WsWebAppSummary

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WsWebAppSummary"
    }
}

Nested Schema : WsWebAppSummary

Type: object

Show Source

• activeSessionsPerMin(optional): integer(int32)
• ajaxErrorPercentage(optional): number(float)
• ajaxErrors(optional): integer(int32)
• ajaxHealth(optional): number(float)
• ajaxRequests(optional): integer(int32)
• apdex(optional): number(float)
• appName(optional): string
• avgAjaxLoadTime(optional): number(float)
• avgConnectTime(optional): number(float)
• avgDnsTime(optional): number(float)
• avgPageFirstByteTime(optional): number(float)
• avgPageInteractiveTime(optional): number(float)
• avgPageLoadTime(optional): number(float)
• avgPageViewingTime(optional): number(float)
• avgRedirectTime(optional): number(float)
• avgSecureConnectTime(optional): number(float)
• connections(optional): integer(int32)
• dnsLookups(optional): integer(int32)
• frustratedAjaxRequests(optional): integer(int32)
• frustratedFullPageUpdates(optional): integer(int32)
• frustratedPageLoads(optional): integer(int32)
• frustratedPartialPageUpdates(optional): integer(int32)
• fullPageUpdates(optional): integer(int32)
• pageClicks(optional): integer(int32)
• pageLoads(optional): integer(int32)
• pageViews(optional): integer(int32)
• partialPageUpdates(optional): integer(int32)
• satisfiedAjaxRequests(optional): integer(int32)
• satisfiedFullPageUpdates(optional): integer(int32)
• satisfiedPageLoads(optional): integer(int32)
• satisfiedPartialPageUpdates(optional): integer(int32)
• scriptErrors(optional): integer(int32)
• toleratingAjaxRequests(optional): integer(int32)
• toleratingFullPageUpdates(optional): integer(int32)
• toleratingPageLoads(optional): integer(int32)
• toleratingPartialPageUpdates(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "appName":{
            "type":"string"
        },
        "activeSessionsPerMin":{
            "type":"integer",
            "format":"int32"
        },
        "pageLoads":{
            "type":"integer",
            "format":"int32"
        },
        "pageClicks":{
            "type":"integer",
            "format":"int32"
        },
        "ajaxRequests":{
            "type":"integer",
            "format":"int32"
        },
        "ajaxErrors":{
            "type":"integer",
            "format":"int32"
        },
        "scriptErrors":{
            "type":"integer",
            "format":"int32"
        },
        "partialPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "fullPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "frustratedPageLoads":{
            "type":"integer",
            "format":"int32"
        },
        "toleratingPageLoads":{
            "type":"integer",
            "format":"int32"
        },
        "satisfiedPageLoads":{
            "type":"integer",
            "format":"int32"
        },
        "frustratedPartialPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "toleratingPartialPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "satisfiedPartialPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "frustratedFullPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "toleratingFullPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "satisfiedFullPageUpdates":{
            "type":"integer",
            "format":"int32"
        },
        "frustratedAjaxRequests":{
            "type":"integer",
            "format":"int32"
        },
        "toleratingAjaxRequests":{
            "type":"integer",
            "format":"int32"
        },
        "satisfiedAjaxRequests":{
            "type":"integer",
            "format":"int32"
        },
        "dnsLookups":{
            "type":"integer",
            "format":"int32"
        },
        "connections":{
            "type":"integer",
            "format":"int32"
        },
        "pageViews":{
            "type":"integer",
            "format":"int32"
        },
        "apdex":{
            "type":"number",
            "format":"float"
        },
        "ajaxHealth":{
            "type":"number",
            "format":"float"
        },
        "avgPageLoadTime":{
            "type":"number",
            "format":"float"
        },
        "avgDnsTime":{
            "type":"number",
            "format":"float"
        },
        "avgConnectTime":{
            "type":"number",
            "format":"float"
        },
        "avgSecureConnectTime":{
            "type":"number",
            "format":"float"
        },
        "avgRedirectTime":{
            "type":"number",
            "format":"float"
        },
        "avgPageInteractiveTime":{
            "type":"number",
            "format":"float"
        },
        "avgPageFirstByteTime":{
            "type":"number",
            "format":"float"
        },
        "avgPageViewingTime":{
            "type":"number",
            "format":"float"
        },
        "avgAjaxLoadTime":{
            "type":"number",
            "format":"float"
        },
        "ajaxErrorPercentage":{
            "type":"number",
            "format":"float"
        }
    }
}

Back to Top