This topic covers the Apigee Analytics Services API. Apigee Edge records a wide variety of operational and business data that flows across APIs. The metrics derived from this data are useful for operational monitoring and business monitoring. Using Analytics Services, you can, for example, determine which APIs are performing well or poorly, which developers are delivering the highest value traffic, and which apps are causing the most issues for your backend services.
To help access this data easily, Apigee Edge Analytics Services exposes a RESTful API. You can use this API when you need to automate certain Analytics functions, such as retrieving metrics periodically using an automation client or script. You can also use the API to build your own visualizations in the form of custom widgets that you can embed in portals or custom apps.
This topic demonstrates the RESTful Analytics API. To learn how to use Analytics in the API Edge management UI see Analytics Services overview.
Getting the number of API calls per month
If you want to see the total number of calls made to your APIs per month, see the Get API message counts SmartDocs management API.
The API must be run for each organization and each envronment. Here's the call in cURL:
curl -v "https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{environment}/stats/?select=sum(message_count)&timeRange=03/01/2016%2000:00~03/31/2016%2024:00" -u email
Dates/times are in UTC and use the following format: MM/DD/YYYY HH:MM, with the range separated by a tilde (~). For cURL, the %20 URL encoding is required for the space between the date and time.
This is an abbreviated version of the /stats API, which provides additional query parameters and dimension resource paths for more granular analytics reporting. For more information, see Get metrics organized by dimensions, as well as the information that follows.
Getting metrics with the management API
Use the Get metrics organized by dimensions management API to get API metrics over a specified time period. In Apigee Edge, metrics can be shown in the context of dimensions, or groupings. For example, you may have gotten 20,000 API calls over the past hour. Dimensions make that data more meaningful by grouping the numbers. When you use the "API proxy" dimension to retrieve the traffic metrics, you'll see that API proxy A got 10,000 calls, API proxy B got 6,000 calls, and API proxy C got 4,000 calls.
For example, to get metrics grouped by API proxies, you'd use the following base URL to call the management API (the type of metrics and other API controls are provided with query parameters, not shown here):
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/apiproxy
To get metrics grouped by developers:
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/developer
To get metrics grouped by developer apps:
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/developer_app
You will find that if you submit one of these requests, you will get the following error:
{
"code" : "analytics.dataapi.service.MissingSelectParameter",
"message" : "Missing select parameter",
"contexts" : [ ]
}
Now you need to add a select statement to the base URL for the chosen dimension. You create the select statement using query parameters.
Query parameters define:
- Metrics: The type of data you want. For more information about metrics, see Analytics metrics, dimensions, and filters reference.
- Functions: The optional aggregate function run against the metric, such as avg, min, max, sum.
TimeRange: The time interval over which data should be analyzed, in the form MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM.
Notice the "%20" before "HH:MM". The TimeRange requires an URL-encoded space character before HH:MM, or a "+" character, as in: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.
Do not use 24:00 as the time because it wraps around to 00:00. Use 23:59 instead.
- Filters: The attribute used to limit the results.
Let's suppose that you want to get metrics for your API proxies that are deployed in the test
environment. You want to find out how many request messages were received by all API proxies
between 6/24/2017 and 6/25/2017. You want to find out a daily count for messages that were
received. To do so, you create a select statement on the
/stats/apiproxy resource.
The example below demonstrates who you would construct a request for these metrics. The select
statement defines the aggregate function sum for the metric
message_count on the dimension apiproxy deployed in the
test environment. The report provides a snapshot of the request message throughput
to all APIs for traffic received between the beginning of 6/20/2017 and the end of 6/21/2017, in
UTC time:
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=06/20/2017%2000:00~06/21/2017%2023:59&timeUnit=day" \
-u email:password
Sample Response:
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [ {
"name" : "sum(message_count)",
"values" : [ {
"timestamp" : 1498003200000,
"value" : "1100.0"
} ]
} ],
"name" : "target-reroute"
} ],
"name" : "test"
} ]...
}
This response indicates that 1100 message were received by one API proxy called 'target-reroute' running in the test environment between the start of 6/20/2017 and the end of 6/21/2017, UTC time.
To get metrics for other dimensions, specify a different dimension as the URI parameter. For
example, you can specify the developer_app dimension to retrieve metrics for
developer apps. The following report shows the total throughput (messages received) from any apps
for the specified time interval:
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/developer_app?"select=sum(message_count)&timeRange=06/20/2017%2000:00~06/21/2017%2023:59&timeUnit=day" \
-u email:password
{
"environments": [
{
"dimensions": [
{
"metrics": [
{
"name": "sum(message_count)",
"values": [
{
"timestamp": 1498003200000,
"value": "886.0"
}
]
}
],
"name": "Test-App"
},
{
"metrics": [
{
"name": "sum(message_count)",
"values": [
{
"timestamp": 1498003200000,
"value": "6645.0"
}
]
}
],
"name": "johndoe_app"
},
{
"metrics": [
{
"name": "sum(message_count)",
"values": [
{
"timestamp": 1498003200000,
"value": "1109.0"
}
]
}
],
"name": "marys_app"
}
]...
}
Sorting results by relative ranking
Many times when getting metrics, you only want to get results for a subset of the total set of
data. Usually, you need to get the results for the "top 10", for example, the "top 10 slowest
APIs", the "top 10 most active apps". You can do this using the topk query parameter
as part of the request.
For example you may be interested to know who your top developers are, measured by throughput, or what your worst performers (i.e., 'top slowest') target APIs are by latency.
The topk (meaning 'top k' entities) enables reporting on the entities associated
with the highest value for a given metric. This enables you to filter metrics for a list of
entities that exemplify a particular condition. For example, to find which target URL was the
most error prone over the last week, the topk parameter is appended to the request,
with a value of 1.
In the example below
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/target_url?"select=sum(is_error)&timeRange=05/08/2017%2000:00~05/15/2017%2000:00&timeUnit=week&sortby=sum(is_error)&topk=1" -u email:password
{
"environments": [
{
"dimensions": [
{
"metrics": [
{
"name": "sum(is_error)",
"values": [
{
"timestamp": 1494201600000,
"value": "12077.0"
}
]
}
],
"name": "http://api.company.com"
}
]...
}
The result of this request is a set of metrics that shows that the buggiest target URL is
http://api.company.com.
You can also use the topk parameter to sort for the APIs experiencing the highest
throughput. The following example retrieves metrics on the top ranked API, defined by highest
throughput in the last week:
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=05/08/2017%2000:00~05/15/2017%2000:00&timeUnit=day&sortby=sum(message_count)&sort=DESC&topk=1" \
-u email:password
Sample Response
{
"environments": [
{
"dimensions": [
{
"metrics": [
{
"name": "sum(message_count)",
"values": [
{
"timestamp": 1494720000000,
"value": "5750.0"
},
{
"timestamp": 1494633600000,
"value": "5752.0"
},
{
"timestamp": 1494547200000,
"value": "5747.0"
},
{
"timestamp": 1494460800000,
"value": "5751.0"
},
{
"timestamp": 1494374400000,
"value": "5753.0"
},
{
"timestamp": 1494288000000,
"value": "5751.0"
},
{
"timestamp": 1494201600000,
"value": "5752.0"
}
]
}
],
"name": "testCache"
}
],
"name": "test"
}
]...
}
Filtering results
For greater granularity, you can filter results to limit the data returned. When using filters, you must use dimensions as filter properties.
For example, let's suppose that you need to retrieve a count of errors from backend services
filtered by the HTTP verb of the request. Your goal is find out how many POST and PUT requests
are generating errors per backend service. To do so, you use the dimension
target_url along with the filter request_verb.
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/target_url?"select=sum(is_error)&timeRange=05/08/2017%2000:00~05/15/2017%2000:00&timeUnit=week&filter=(request_verb%20in%20'POST','PUT')" \
-u email:password
Sample response:
{
"environments" : [
{
"dimensions" : [
{
"metrics" : [
{
"name" : "sum(is_error)",
"values" : [
{
"timestamp" : 1519516800000,
"value" : "1.0"
}
]
}
],
"name" : "testCache"
}
],
"name" : "test"
}
]...
}
Paginating results
In production environments, some request to the Analytics Services API return very large data sets. To make it easy to display large data sets in the context of a UI-based application, the API natively supports pagination.
To paginate results, use the offset and limit query parameters,
along with the sortby sorting parameter to ensure a consistent ordering of
items.
For example, the following request would be likely to return a large data set, since it retrieves metrics for all errors on all APIs in the product environment for the last week.
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/prod/stats/apiproxy?"select=sum(is_error)&timeRange=05/08/2017%2000:00~05/15/2017%2000:00&timeUnit=week&sortby=sum(is_error)" \
-u email:password
If your UI-based application can reasonably display 50 results per page, you can set the limit
to 50. Since 0 counts as the first item, the following call returns items 0-49 in descending
order (sort=DESC is the default).
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/prod/stats/apiproxy?"select=sum(is_error)&timeRange=05/08/2017%2000:00~05/15/2017%2000:00&timeUnit=week&sortby=sum(is_error)&limit=50&offset=0" \
-u email:password
For the second 'page' of results, use the offset query parameter, as follows. Note that the limit and offset are identical. That's because 0 counts as the first item. With a limit of 50 and an offset of 0, items 0-49 are returned. With an offset of 50, items 50-99 are returned.
$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/prod/stats/apiproxy?"select=sum(is_error)&timeRange=05/08/2017%2000:00~05/15/2017%2000:00&timeUnit=week&sortby=sum(is_error)&limit=50&offset=50" \
-u email:password
Opt in or out of daily analytics reports
In addition to the analytics available online through Apigee Edge, all organization administrators are automatically subscribed to receive daily analytics summary reports through email. You can unsubscribe (opt out) of receiving daily analytics reports through an opt out link in the actual report that is emailed to you. You can also opt in or opt out of daily summary reports using these API calls:
Opt out of receiving a daily summary report:
$ curl -u email:password https://api.enterprise.apigee.com/v1/o/{myorg}/stats/preferences/reports/dailysummaryreport?optin=false
Opt in to receiving a daily summary report:
$ curl -u email:password
https://api.enterprise.apigee.com/v1/o/{myorg}/stats/preferences/reports/dailysummaryreport?optin=true
Retrieve list of users who have opted in or opted out:
$ curl -u email:password
https://api.enterprise.apigee.com/v1/o/{myorg}/stats/preferences/reports/dailysummaryreport/users