
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET ApiResponseTimeSummary

Represents summarized information about response times for each service.

Since Product Version: 2.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/data/ApiResponseTimeSummary

## Response Parameters

Attribute | Description
--- | ---
average long | The arithmetic mean, or average response time, measured in milliseconds.
latest long | The latest response time, measured in milliseconds.
max long | The maximum response time, measured in milliseconds.
min long | The minimum response time, measured in milliseconds.
path String | The path of the service.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://172.20.127.108/webacs/api/v1/data/ApiResponseTimeSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="ApiResponseTimeSummary" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v1/data/ApiResponseTimeSummary/15" rootUrl="https://172.20.127.108/webacs/api/v1/data">
      <entity dtoType="apiResponseTimeSummaryDTO" type="ApiResponseTimeSummary" url="https://172.20.127.108/webacs/api/v1/data/ApiResponseTimeSummary/15">
        <apiResponseTimeSummaryDTO displayName="String value" id="15" uuid="String value">
          <average>2</average>
          <latest>2</latest>
          <max>2</max>
          <min>2</min>
          <path>String value</path>
        </apiResponseTimeSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://172.20.127.108/webacs/api/v1/data/ApiResponseTimeSummary/15.json

    {
      "queryResponse" : {
        "@type" : "ApiResponseTimeSummary",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/ApiResponseTimeSummary\/15",
        "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data",
        "entity" : {
          "@dtoType" : "apiResponseTimeSummaryDTO",
          "@type" : "ApiResponseTimeSummary",
          "@url" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/ApiResponseTimeSummary\/15",
          "apiResponseTimeSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : "15",
            "@uuid" : "String value",
            "average" : 2,
            "latest" : 2,
            "max" : 2,
            "min" : 2,
            "path" : "String value"
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/ApiResponseTimeSummary

Unmodified

This resource has not been modified since the previous API version.

## Response Parameters

Attribute | Description
--- | ---
average long | The arithmetic mean, or average response time, measured in milliseconds.
latest long | The latest response time, measured in milliseconds.
max long | The maximum response time, measured in milliseconds.
min long | The minimum response time, measured in milliseconds.
path String | The path of the service.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://172.20.127.108/webacs/api/v2/data/ApiResponseTimeSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="ApiResponseTimeSummary" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v2/data/ApiResponseTimeSummary/15" rootUrl="https://172.20.127.108/webacs/api/v2/data">
      <entity dtoType="apiResponseTimeSummaryDTO" type="ApiResponseTimeSummary" url="https://172.20.127.108/webacs/api/v2/data/ApiResponseTimeSummary/15">
        <apiResponseTimeSummaryDTO displayName="String value" id="15" uuid="String value">
          <average>2</average>
          <latest>2</latest>
          <max>2</max>
          <min>2</min>
          <path>String value</path>
        </apiResponseTimeSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://172.20.127.108/webacs/api/v2/data/ApiResponseTimeSummary/15.json

    {
      "queryResponse" : {
        "@type" : "ApiResponseTimeSummary",
        "@requestUrl" : "https://172.20.127.108/webacs/api/v2/data/ApiResponseTimeSummary/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "apiResponseTimeSummaryDTO",
          "@type" : "ApiResponseTimeSummary",
          "@url" : "https://172.20.127.108/webacs/api/v2/data/ApiResponseTimeSummary/15",
          "apiResponseTimeSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "average" : 2,
            "latest" : 2,
            "max" : 2,
            "min" : 2,
            "path" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/ApiResponseTimeSummary

Unmodified

This resource has not been modified since the previous API version.

## Response Parameters

Attribute | Description
--- | ---
average long | The arithmetic mean, or average response time, measured in milliseconds.
latest long | The latest response time, measured in milliseconds.
max long | The maximum response time, measured in milliseconds.
min long | The minimum response time, measured in milliseconds.
path String | The path of the service.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://172.20.127.108/webacs/api/v3/data/ApiResponseTimeSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="ApiResponseTimeSummary" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v3/data/ApiResponseTimeSummary/15" rootUrl="https://172.20.127.108/webacs/api/v3/data">
      <entity dtoType="apiResponseTimeSummaryDTO" type="ApiResponseTimeSummary" url="https://172.20.127.108/webacs/api/v3/data/ApiResponseTimeSummary/15">
        <apiResponseTimeSummaryDTO displayName="String value" id="15" uuid="String value">
          <average>2</average>
          <latest>2</latest>
          <max>2</max>
          <min>2</min>
          <path>String value</path>
        </apiResponseTimeSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://172.20.127.108/webacs/api/v3/data/ApiResponseTimeSummary/15.json

    {
      "queryResponse" : {
        "@type" : "ApiResponseTimeSummary",
        "@requestUrl" : "https://172.20.127.108/webacs/api/v3/data/ApiResponseTimeSummary/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "apiResponseTimeSummaryDTO",
          "@type" : "ApiResponseTimeSummary",
          "@url" : "https://172.20.127.108/webacs/api/v3/data/ApiResponseTimeSummary/15",
          "apiResponseTimeSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "average" : 2,
            "latest" : 2,
            "max" : 2,
            "min" : 2,
            "path" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/ApiResponseTimeSummary

Unmodified

This resource has not been modified since the previous API version.

## Response Parameters

Attribute | Description
--- | ---
average long | The arithmetic mean, or average response time, measured in milliseconds.
latest long | The latest response time, measured in milliseconds.
max long | The maximum response time, measured in milliseconds.
min long | The minimum response time, measured in milliseconds.
path String | The path of the service.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://172.20.127.108/webacs/api/v4/data/ApiResponseTimeSummary/15

    <?xml version="1.0" ?>
    <queryResponse type="ApiResponseTimeSummary" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v4/data/ApiResponseTimeSummary/15" rootUrl="https://172.20.127.108/webacs/api/v4/data">
      <entity dtoType="apiResponseTimeSummaryDTO" type="ApiResponseTimeSummary" url="https://172.20.127.108/webacs/api/v4/data/ApiResponseTimeSummary/15">
        <apiResponseTimeSummaryDTO displayName="String value" id="15" uuid="String value">
          <average>2</average>
          <latest>2</latest>
          <max>2</max>
          <min>2</min>
          <path>String value</path>
        </apiResponseTimeSummaryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://172.20.127.108/webacs/api/v4/data/ApiResponseTimeSummary/15.json

    {
      "queryResponse" : {
        "@type" : "ApiResponseTimeSummary",
        "@requestUrl" : "https://172.20.127.108/webacs/api/v4/data/ApiResponseTimeSummary/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "apiResponseTimeSummaryDTO",
          "@type" : "ApiResponseTimeSummary",
          "@url" : "https://172.20.127.108/webacs/api/v4/data/ApiResponseTimeSummary/15",
          "apiResponseTimeSummaryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "average" : 2,
            "latest" : 2,
            "max" : 2,
            "min" : 2,
            "path" : "String value"
          }
        } ]
      }
    }