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 logged in. 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
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

GET

URL

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

Sample Request

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

Sample 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_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

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
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

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 ReportType.
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. The StartDate, EndDate, and Duration fields work together to define the information to be returned. If not specified, defaults to two hours (2h).
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 as a single metric for the entire duration. For example, if daily data for the year is requested, there 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.

Response

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

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Wed, 13 May 2020 20:00:00 GMT
Content-Type: application/json

Sample response body: application/json

{
  "StartTime":"2020-05-13T21:10:00-07:00",
  "EndTime":"2020-05-13T22:10:00-07:00",
  "Interval":[
    {
      "Metric":[
        {
          "Name":"avgResponseTime",
          "Value":1047
        },
        {
          "Name":"minResponseTime",
          "Value":-1
        },
        {
          "Name":"maxResponseTime",
          "Value":1047
        },
        {
          "Name":"totalCount",
          "Value":1
        },
        {
          "Name":"successCount",
          "Value":0
        },
        {
          "Name":"faultCount",
          "Value":1
        },
        {
          "Name":"totalRequestSize",
          "Value":0
        },
        {
          "Name":"totalResponseSize",
          "Value":225
        }
      ],
      "StartTime":"2020-05-13T22:07:00-07:00"
    },
    {
      "Metric":[
        {
          "Name":"avgResponseTime",
          "Value":22
        },
        {
          "Name":"minResponseTime",
          "Value":-1
        },
        {
          "Name":"maxResponseTime",
          "Value":22
        },
        {
          "Name":"totalCount",
          "Value":1
        },
        {
          "Name":"successCount",
          "Value":0
        },
        {
          "Name":"faultCount",
          "Value":1
        },
        {
          "Name":"totalRequestSize",
          "Value":0
        },
        {
          "Name":"totalResponseSize",
          "Value":225
        }
      ],
      "StartTime":"2020-05-13T22:08:00-07:00"
    }
  ]
}

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

Response Body

Name	Type	Description
Graph	Graph	Contains metric information.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.