GET /api/apis/versions/{APIVersionID}/metrics

Returns a set of metric information for the specified API version, in JSON or XML format, that can be used to create a chart.

For additional information regarding the set of operations dealing with metric information, see Metrics on the Platform.

Note: This operation returns metric data as a chart; the GET /api/apis/versions/{APIVersionID}/metrics/export operation returns the data as a table.

Authorization Roles/Permissions: Must be a user with Monitor permission for the API; an API Admin or Business Admin or an app developer who has a contract with the API.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/metrics

Back to top

Sample Request

The example below shows a request for the metric information for the specified API version.

Request URL

https://{hostname}/api/apis/versions/apiversion18972.acmepaymentscorp/metrics?TimeInterval=5s&Duration=1m&Environment=Sandbox

Sample request headers

GET /api/apis/versions/apiversion18972.acmepaymentscorp/metrics?TimeInterval=5s&Duration=1m&Environment=Sandbox HTTP/1.1
Host: {hostname}
Accept: */*
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, text/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
ContractID Path string Optional The unique ID for a specific contract between an app version and an API version.
AppVersionID Path string Optional The unique ID for a specific app version.
ReportType Query string Optional The type of metric information. For valid values, see Report Type.
Environment Query string Optional The environment (implementation) (Sandbox or Production). If not specified, defaults to Production.
StartDate Query string Required The beginning point for the date range of metric information requested. Format: YYYY-MM-DD:THH:MM:SS. Example: StartDate=2011-01-01T11:55:22. If StartDate is not specified, the operation uses EndDate minus Duration. If both StartDate and EndDate are unspecified, the operation returns information for the Duration value, and if Duration is also unspecified it returns default Duration value of 2 hours.
EndDate Query string Optional The ending point for the date range of metric information requested. Format: YYYY-MM-DD:THH:MM:SS. Example: EndDate=2011-01-02T11:55:22. If not specified, defaults to the current date/time of the API call.
TimeZone Query string Optional The time zone for the information. If a time zone isn't specified, the information is returned in GMT. For more information, refer to Working with Time Zones and Time Intervals.
TimeInterval Query string Optional The time interval for the metric information to be returned. For example, you might want data points every 10 seconds. If not specified, defaults to five-second intervals (5s). The StartDate, EndDate, and Duration fields work together to define the information to be returned; the TimeInterval determines the data points. For more information, refer to Working with Time Zones and Time Intervals.
Duration Query string Optional The duration for the metric information. For example, you might want metric information for a 24-hour period or only for an hour. If not specified, defaults to two hours (2h). The StartDate, EndDate, and Duration fields work together to define the information to be returned.
ShowSummary Query boolean Optional Indicates whether a summary of the metric information should be included in the information returned. For example, if the metric information includes daily metrics for 7 days, the summary would include one set of totals. If not specified, this defaults to false, meaning that no summary is included. If a summary is requested, it is expressed a single metric for the entire duration. For example, if daily data for the year is requested, thre are 365 points, and the summary is a total.
ShowSLAs Query boolean Optional Indicates whether SLAs should be included in the information returned. If not specified, defaults to false, meaning that SLAs are not returned.
ShowIntervalData Query boolean Optional Indicates whether the metric information that's returned should be broken up by time interval. For example, if the TimeInterval value is five minutes (5m) and the Duration value is one hour (1h), and ShowIntervalData is set to true, the results would include 12 sets of information, one for each five-minute interval. Time interval data can be used to create a bar chart.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the metrics for the specified API version in JSON or XML format.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Thu, 17 Apr 2014 20:47:50 GMT
Content-Type: application/json

Sample response body: application/json

{
"StartTime" : "2014-04-17T00:00:00Z",
"EndTime" : "2014-04-18T00:00:00Z",
"Summaries" : [ {
"Metric" : [ {
"Name" : "avgResponseTime",
"Value" : -1
}, {
"Name" : "minResponseTime",
"Value" : 0
}, {
"Name" : "maxResponseTime",
"Value" : 0
}, {
"Name" : "totalCount",
"Value" : 0
}, {
"Name" : "successCount",
"Value" : 0
}, {
"Name" : "faultCount",
"Value" : 0
} ],
"StartTime" : "2014-04-17T20:46:55Z",
"EndTime" : "2014-04-17T20:47:55Z",
"Duration" : "P0Y0M0DT0H1M0.000S"
}, {
"Metric" : [ {
"Name" : "avgResponseTime",
"Value" : 248
}, {
"Name" : "minResponseTime",
"Value" : 248
}, {
"Name" : "maxResponseTime",
"Value" : 248
}, {
"Name" : "totalCount",
"Value" : 1
}, {
"Name" : "successCount",
"Value" : 1
}, {
"Name" : "faultCount",
"Value" : 0
} ],
"StartTime" : "2014-04-17T00:00:00Z",
"EndTime" : "2014-04-18T00:00:00Z",
"Duration" : "P0Y0M1DT0H0M0.000S"
} ]
}

Sample response headers: application/xml

HTTP/1.1 200 OK
Date: Thu, 17 Apr 2014 20:49:50 GMT
Content-Type: text/xml

Sample response body: application/json

<?xml version="1.0" encoding="UTF-8"?>
<Graph xmlns="http://soa.com/xsd/performance/1.0">
  <StartTime>2014-04-17T21:51:50Z</StartTime>
  <EndTime>2014-04-17T21:52:50Z</EndTime>
  <Summaries Duration="P0Y0M0DT0H1M0.000S">
    <Metric>
      <Name>avgResponseTime</Name>
      <Value>-1</Value>
    </Metric>
    <Metric>
      <Name>minResponseTime</Name>
      <Value>0</Value>
    </Metric>
    <Metric>
      <Name>maxResponseTime</Name>
      <Value>0</Value>
    </Metric>
    <Metric>
      <Name>totalCount</Name>
      <Value>0</Value>
    </Metric>
    <Metric>
      <Name>successCount</Name>
      <Value>0</Value>
    </Metric>
    <Metric>
      <Name>faultCount</Name>
      <Value>0</Value>
    </Metric>
    <StartTime>2014-04-17T21:51:50Z</StartTime>
    <EndTime>2014-04-17T21:52:50Z</EndTime>
  </Summaries>
  <Summaries Duration="P0Y0M1DT0H0M0.000S">
    <Metric>
      <Name>avgResponseTime</Name>
      <Value>248</Value>
    </Metric>
    <Metric>
      <Name>minResponseTime</Name>
      <Value>248</Value>
    </Metric>
    <Metric>
      <Name>maxResponseTime</Name>
      <Value>248</Value>
    </Metric>
    <Metric>
      <Name>totalCount</Name>
      <Value>1</Value>
    </Metric>
    <Metric>
      <Name>successCount</Name>
      <Value>1</Value>
    </Metric>
    <Metric>
      <Name>faultCount</Name>
      <Value>0</Value>
    </Metric>
    <StartTime>2014-04-17T00:00:00Z</StartTime>
    <EndTime>2014-04-18T00:00:00Z</EndTime>
  </Summaries>
</Graph>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, text/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

Name Type Description
Graph Graph Contains metric information.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics