GET /api/apps/versions/{AppVersionID}/metrics/export

Exports a summary of metric information for the specified app version, in the form of a CSV file.

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

Note: This operation returns metric data as table in an exported CSV file; GET /api/apps/versions/{AppVersionID}/metrics returns the same data as a JSON object that can be used in a chart.

Authorization Roles/Permissions: Must be logged in. Must have monitor permission for the app; an App team member, Business Admin, or API Admin for an API that the app has a contract with.

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/apps/versions/{AppVersionID}/metrics/export

Sample Request

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

Sample request URL

http://{hostname}/api/apps/versions/7FZJvSXlIP12IHKF3DufbL1W.acmepaymentscorp/metrics?
Duration=1m&Duration=1d&Environment=Sandbox&ShowSummary=true&ShowIntervalData=false

Sample request headers

GET /api/apps/versions/7FZJvSXlIP12IHKF3DufbL1W.acmepaymentscorp/metrics/export?TimeInterval=1h
&Duration=All&ReportType=app.all.apis&Environment=All HTTP/1.1
Host: <localhost>
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
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	text/csv
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
AppVersionID	Path	string	Required	The unique ID for a specific app version.
ReportType	Query	string	Optional	The type of metric information. For valid values, see ReportType.
ContractID	Query	string	Required	The unique ID for a specific contract between an app version and an API version.
ApiVersionID	Path	string	Required	The unique ID for a specific API version.
OperationName	Query	string	Required	The specific operation for which information should be returned. Note: Must be used in combination with the ApiVersionID parameter.
Environment	Query	string	Required	The environment (implementation) (Sandbox or Production). If not specified, defaults to Sandbox.
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	Required	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.
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.

Response

If successful, this operation returns HTTP status code 200, with the information in an exported CSV file.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Wed, 19 Mar 2014 14:56:18 GMT
Content-Type: text/csv
Content-Disposition: attachment;filename="export.csv"

Sample response body

The response body is the export.csv file. View an example.

Response Headers

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

Header	Description
Content-Type	text/csv
Content-Disposition	attachment;filename="export.csv"

Response Body

Name	Type	Description
export.csv	File attachment	A CSV file containing the exported data. The specific data included in the file depends on the parameters included in the request: If the reporttype parameter is included in the request, the response has these columns: APIName Count If the reporttype parameter is not included in the request, the response has these columns: startTime avgResponseTime minResponseTime maxResponseTime totalCount successCount faultCount

Name

Type

Description

export.csv

File attachment

A CSV file containing the exported data. The specific data included in the file depends on the parameters included in the request:

If the reporttype parameter is included in the request, the response has these columns:

APIName
Count

If the reporttype parameter is not included in the request, the response has these columns:

startTime
avgResponseTime
minResponseTime
maxResponseTime
totalCount
successCount
faultCount

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.