Analytics Event Export API

1.0.x
(1 review)

Short description

The Analytics Event Export API enables you to extract raw data related to the usage of your APIs.

Detailed description

The Analytics Events Export API allows you to query and extract the raw event data captured by the Mule runtime. You can create reports with this API by executing queries that filter events based on a date range and choosing which properties you want to extract. For example, you can query for policies that have been violated and the outcomes of those requests. Or, you can determine the most common location from where your users are accessing your API and the browsers they have.

You can export data for all APIs, or from a specific API and version.

Overview

When a request is placed against one of your APIs, properties of this request are enriched and stored in way that allows you to analyze the usage and performance of your applications. outcome of the request, any possible policy violations, and response times are among the attributes tracked by API Analytics. This information is available through the Analytics Event Export API, enabling you to extract, perform data analysis and provide insight into how your APIs are being used and how they are performing.

The Analytics Events Export API provides a one month retention policy and a data availability delay of up to 10 minutes. It also enforces a usage limit of 10 requests/minute, with a maximum of 20,000 events per request. Request rates higher than 10 request/minute are throttled.

To access this API you must send a request with a valid token. See the Getting Started section to understand how to obtain a token and use it in this API.

Getting started

To use this API you must get an access token. The following example request shows how to obtain one. The response includes an access_token field with the token. You should use this in every request to the Analytics Events Export API. The token should be sent in the Authorization header.

curl -s 'https://anypoint.mulesoft.com/accounts/login' -d “username=<YOUR-USERNAME>&password=<YOUR-PASSWORD>”

Response:

 {
   "access_token": "54545454-5454-5454-5454-545454545454",
   "token_type": "Bearer",
   "redirectUrl": "/home"
 }

For every request, send the following header using the access token:

-H 'Authorization: Bearer <token>'

See the Usage Examples and API Reference sections for further details and a thorough description on how to use this API.

Reviews