GET /api/businesses/{BusinessID}/metrics/export

Exports metric information for the business.

Authorization Roles/Permissions: Must be logged in. Must have Monitor permission for the resource. Must have visibility of the business organization.

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/businesses/{BusinessID}/metrics/export

Sample Request

The example below shows a request to export the business data.

Sample Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/metrics/export

Sample request headers

Host: {hostname}
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	*/*
Content-Type	Any format (/)
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
BusinessID	Path	string	Required	The unique ID for a specific business organization on the platform.
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	Optional	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.
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 metric information.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 29 Apr 2016 16:50:21 GMT
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=business-export.zip

Sample response body

The response body is the business-export.zip file. Click here to view an example.

Response Headers

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

Header	Description
Content-Type	*/*

Response Body