Jump to

• Request
• Response

Get Application Summary for server requests

get

/serviceapi/apm.dataserver/api/v1/applications/summary/{applicationName}/serverSummary

Retrieve the application rollup information for serverRequest on a given application name

Request

Supported Media Types

• application/json

Path Parameters

• applicationName: string

Query Parameters

• aggregatePeriod(optional): integer(int32)
  Aggregation period applied to time range between the since and until parameters. This parameter's value is in 1-minute units. The default time series aggregation period is 60 minutes. Each bucket in the returned time series data represents the number of minutes in the aggregation period. See Time Series for more details.
• includeTimeSeries(optional): boolean
  Includes time series data if set to true
• 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 : EntitySummaryModel

Type: object

REST API response holder class

Show Source

• averageResponseTime(optional): number
• count(optional): integer(int64)
• errorPercentage(optional): number
• failureCount(optional): integer(int64)
• itemId(optional): string
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• maxResponseTime(optional): integer(int64)
• minResponseTime(optional): integer(int64)
• queryTimeRange(optional): object TimeRange
• timeSeries(optional): object EntityGraphDataArray
  Information about a Server Time Series Graph (EntityGraphDataArray)
• volumeRate(optional): number
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "averageResponseTime":{
            "type":"number"
        },
        "volumeRate":{
            "type":"number"
        },
        "errorPercentage":{
            "type":"number"
        },
        "minResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "maxResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "failureCount":{
            "type":"integer",
            "format":"int64"
        },
        "timeSeries":{
            "$ref":"#/definitions/EntityGraphDataArray"
        },
        "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":"REST API response holder class"
}

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

Type: object

Information about a Server Time Series Graph (EntityGraphDataArray)

Show Source

• averageResponseTime(optional): array averageResponseTime
• bucket(optional): array bucket
• completedCount(optional): array completedCount
• count(optional): integer(int32)
• errorPercentage(optional): array errorPercentage
• 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
• satisfiedCount(optional): array satisfiedCount
• time(optional): array time
• timeFormatter(optional): object ITimeFormatter
• toleratingCount(optional): array toleratingCount
• totalTime(optional): array totalTime
• volumeRate(optional): array volumeRate
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "longKey":{
            "type":"string"
        },
        "volumeRate":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "errorPercentage":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "satisfiedCount":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "toleratingCount":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "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 Server Time Series Graph (EntityGraphDataArray)"
}

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

Type: array

Show Source

• Array of: number

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

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

Type: array

Show Source

• Array of: number

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

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

Type: array

Show Source

• Array of: number

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

Nested Schema : totalTime

Type: array

Show Source

• Array of: integer(int64)

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

Nested Schema : volumeRate

Type: array

Show Source

• Array of: number

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

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