Analytics metrics, dimensions, and filters reference

Average number of transactions, meaning API proxy requests, per second. Note that if you have a relatively low number of transactions over the time period, the average number of transactions per second could appear to be zero in UI custom reports if the number is smaller than two decimal places.

API syntax: tps

Number of successful API requests that use the ResponseCache instead of the response from the target service.

API syntax: sum(cache_hit)

Number of elements in L1 (in-memory) cache per transaction over a given time period. For example, if you choose max for the period of a day, and within that day the highest number of elements in cache is 12 for a specific transaction, then the count will be 12. For avg , if there are three transactions in the time period you're querying, and their cache counts are 5, 6, and 7, the average is 6. L1 cache is in-memory cache as opposed to L2 database cache, as described in Cache internals .

API syntax: avg(ax_cache_l1_count)

Total number of policy errors over the specified time period.

Policy errors usually occur by design. For example, the VerifyApiKey policy throws an error when an invalid API key is passed in the request, and a SpikeArrest policy throws an error if the number of API calls exceeds the limit defined in the policy. So this metric is useful for finding potential trouble spots in your APIs. For example, policy_error metrics, grouped by the developer_app dimension, might help you discover that an API key or OAuth token has expired for a given app; or you might find that a specific API proxy is throwing a lot of SpikeArrest policy errors, leading you to discover that the proxy's spike arrest limit doesn't account for an increase in holiday traffic.

A policy error is logged in analytics only if the error results in API proxy failure. For example, if a policy's continueOnError attribute is set to true , the API proxy continues processing a request even if the policy fails. In that case, a policy error is not logged in analytics.

The Policy Name on Error ( ax_execution_fault_policy_name ) dimension is useful for grouping policy errors by policy name.

A target failure (such as a 404 or 503 ) does not count as a policy failure. Those count as API proxy failures ( is_error ).

API syntax: sum(policy_error)

Total number of times API proxies failed over the specified time period. Proxy failure can occur when a policy fails or when there's a runtime failure, such as a 404 or 503 from the target service.

The Proxy ( apiproxy ) dimension is useful for grouping API proxy failures by proxy.

API syntax: sum(is_error)

Amount of time (average, minimum, or maximum), in milliseconds, that it takes Apigee to process incoming requests. The time starts when the request reaches Apigee and ends when Apigee forwards the request to the target service.

Using different dimensions, you can examine request processing latencies by API proxy, developer app, region, and so on.

API syntax: max(request_processing_latency)

Size of the request payload received by Apigee, in bytes.

API syntax: avg(request_size)

Total number of times a ResponseCache policy was executed over the given time period.

Since the ResponseCache policy is attached in two places in an API proxy (once in the request and once in the response), it usually executes twice in an API call. A cache GET and a cache PUT each count as one execution.

However, response cache execution is 0 if the <SkipCacheLookup> element in the policy evaluates to true (in the request), and 0 if the <SkipCachePopulation> element in the policy evaluates to true (in the response).

In the Debug tool , you can click the ResponseCache icon in an executed API call and view the responsecache.executed flow variable to see whether or not there was a cache execution (a value of 1).

API syntax: sum(ax_cache_executed)

Amount of time (average, minimum, or maximum), in milliseconds, that it takes Apigee to process API responses. The time starts when the API proxy receives the target service response and ends when Apigee forwards the response to the original caller.

Using different dimensions, you can examine response processing latencies by API proxy, region, and so on.

API syntax: min(response_processing_latency)

Size of the response payload returned to the client, in bytes.

API syntax: max(response_size)

Total number of 5xx responses from the target service. These are target service errors not caused by Apigee.

API syntax: sum(target_error)

Amount of time (sum, average, minimum, or maximum), in milliseconds, for the target server to respond to a call. This metric tells you how target servers are performing. The time starts when Apigee forwards a request to the target service and ends when Apigee receives the response.

Note that if an API call returns a response from cache (using the ResponseCache policy, for example), the call will never reach the target service, and no target response time metrics are logged.

API syntax: avg(target_response_time)

Amount of time (sum, average, minimum, or maximum), in milliseconds, from when Apigee receives a request from a client to when Apigee sends the response back to the client. The time includes network overhead (such as the time it takes load balancers and routers to do their work), request processing latency, response processing latency, and target response time (if the response is served from the target service instead of cache).

Using different dimensions, you can examine processing latencies by API proxy, developer app, region, and so on.

API syntax: avg(total_response_time)

Total number of API calls processed by Apigee in the specified time period.

Use dimensions to group traffic counts in ways that are most meaningful to you.

API syntax: sum(message_count)

Amount representing the setup fee, recurring fees, or prepaid top-up.

API syntax: sum(fees)

Developer's share in a transaction's revenue. Apigee calculates the developer's share only if you have enabled revenue sharing in your rate plan.

The developer's share is calculated using the following formula:

The value of the share percentage is fetched from your rate plan.

API syntax: sum(x_apigee_mintng_dev_share)

Total revenue of a transaction. The revenue of a transaction is set to the value of the revShareGrossPrice monetization variable captured in your DataCapture policy.

API syntax: sum(x_apigee_mintng_price)

The factor (multiplier) by which the per-transaction cost is multiplied. The per-transaction cost is specified in the rate plan's Consumption-based fees pricing.

API syntax: avg(x_apigee_mintng_price_multiplier)

Rate charged for a transaction. The rate charged for a transaction is calculated using the following formula:

The value of the consumption-based pricing rate is fetched from your rate plan and the perUnitPriceMultiplier value is multiplied only if the variable is captured by the DataCapture policy.

API syntax: sum(x_apigee_mintng_rate)

Key containing the ResponseCache value that was accessed. For more information on how the key is constructed for response cache, see ResponseCache policy .

In the Debug tool , when you select a ResponseCache policy that reads from or writes to the cache, you can see this value in the responsecache.cachekey flow variable .

Name of the cache containing the keys/values used by the ResponseCache policy, prefixed with orgName__envName__ . For example, if the org is myorgf , the environment is test , and the cache name is myCache the ax_cache_name is foo__test__myCache .

In the Debug tool , when you select a ResponseCache policy, you can see this value in the responsecache.cachename flow variable .

Cache level (L1 in-memory or L2 database) from which the ResponseCache was retrieved. This dimension also shows CACHE_MISS when the response was delivered from the target instead of cache (and response cache was refreshed with the target response); or when a cache key in the request is invalid. Cache keys are limited to 2 KB in size.

In the Debug tool , when you select the ResponseCache policy, you can see this value in the responsecache.cachesource flow variable .

For more information on cache levels, see Cache internals .

Consumer key (API key) of the developer app making the API calls, whether passed in the request as API keys or included in OAuth tokens.

In order to get this dimension, proxies receiving calls must be configured to check for a valid API key or OAuth token. Developer apps get API keys, which can be used to generate OAuth tokens, when the apps are registered in Apigee. For more information, see How do I generate complete analytics data? .

If the above criteria aren't met, you'll see the value (not set) . See also What does an analytics entity value "(not set)" mean? .

• Email of the Apigee-registered developers whose app made the API calls. This field is not set for AppGroup apps.

  In order to get this dimension, developers or AppGroups must have apps associated with one or more API products that contain the API proxies being called, and the proxies must check for an API key or OAuth token sent with the API call. The key or token identifies the developer app. For more information, see How do I generate complete analytics data? .

  If the above criteria aren't met, you'll see the value (not set) . See also What does an analytics entity value "(not set)" mean? .

• In the context of the fees metric, it will be the developer who should be charged with setup fee, recurring fees, or prepaid top-up.

The fault code of the error. For example: messaging.adaptors.http.flow.GatewayTimeout

Named flow in an API proxy that raised an error. For example, PreFlow , PostFlow , or the name of a conditional flow you created.

Note that the full name to use in the Apigee API is ax_execution_fault_flow_name , without a line break.

Where no errors occurred, you'll see the value (not set) .

Name of the API proxy flow states that raised errors, such as PROXY_REQ_FLOW or TARGET_RESP_FLOW .

Note that the full name to use in the Apigee API is ax_execution_fault_flow_state , without a line break.

Name of the policy that threw an error and caused the API call to fail.

Note that the full name to use in the Apigee API is ax_execution_fault_policy_name , without a line break.

If a policy throws an error but the policy root attribute continueOnError is set to true , the API proxy flow continues without failure, and the policy failure isn't counted in this dimension.

BasePath configured on the API proxy ProxyEndpoint. Base path does not include the domain and port portion of the API proxy URL. For example, if an API proxy's base URL is https://apigeedocs-test.apigee.net/releasenotes/ , the base path is /releasenotes .

The value is also stored in the proxy.basepath flow variable .

The API proxy type for deployed proxies. Specifying a proxy type limits results to that proxy type. Potential values are STANDARD , EXTENSIBLE , or unset.

Resource path added to the API proxy base path. For example, if an API proxy's base URL is https://apigeedocs-test.apigee.net/hello/ , and a call is made to https://apigeedocs-test.apigee.net/hello/json , the pathsuffix is /json .

If no pathsuffix is used, the value is empty.

The value is also stored in the proxy.pathsuffix flow variable .

Originating client IP address. This is either derived using the default client ip address resolution or the algorithm configured in configured client IP resolution .

With the default behavior, the value of the ax_resolved_client_ip dimension is calculated from the values in the ax_true_client_ip and the x_forwarded_for_ip dimensions.

Note that when using routing products such as Akamai to capture the true IP addresses of clients, the client IP is passed to Apigee in the HTTP header True-Client-IP , which is then used to set the ax_true_client_ip dimension.

The value of the ax_resolved_client_ip dimension is calculated as follows:

1. If ax_true_client_ip is not null and does not contain a local IP address, then set ax_resolved_client_ip to ax_true_client_ip .
2. Else, set ax_resolved_client_ip to the first non-local IP address in x_forwarded_for_ip .
3. If both ax_true_client_ip and x_forwarded_for_ip contain only local IPs, then set ax_resolved_client_ip to the last local IP in x_forwarded_for_ip .
4. If both ax_true_client_ip and x_forwarded_for_ip are null, set ax_resolved_client_ip to (not set) .
5. If ax_true_client_ip is a local IP and x_forwarded_for_ip is null, set ax_resolved_client_ip to (not set) .

Operating system version of the device making the call.

It's useful to use this as a second drill-down dimension with OS Family (ax_ua_os_family) to see the versions of the operating systems.

IP address of the calling client, stored in the proxy.client.ip flow variable . This is often the X-Forwarded-For address of the inbound call, which is the IP address Apigee received from the last external TCP handshake. This could be the calling client or a load balancer. When there are multiple IPs in the X-Forwarded-For header, this is the last IP listed.

When using routing products such as Akamai to capture the true IP addresses of clients, the client IPs are passed to Apigee in the HTTP header True-Client-IP . This dimension captures those true client IPs from that header.

To determine the original client IP Address, accessed through the ax_resolved_client_ip dimension, Apigee uses the ax_true_client_ip and the x_forwarded_for_ip dimensions.

Resource path (not including the domain) to the target service, excluding query parameters.

For example, the Apigee sample target http://mocktarget.apigee.net includes several resources, including /user , which returns a greeting. Regardless of how your API proxy calls http://mocktarget.apigee.net/user , the request_path is /user .

Resource path (not including the domain) to the target service, including query parameters.

For example, the Apigee sample target http://mocktarget.apigee.net includes several resources, including /user?user={name} resource and query parameter to return a custom greeting to the name provided. Regardless of how your API proxy calls http://mocktarget.apigee.net/user?user=Dude , the request_uri is /user?user=Dude .

Name of the user agent, or software agent, used to make the API call. Examples:

• A Pixel XL making a call through Chrome: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
• An iPad making a call through Chrome: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
• cURL from a terminal: curl/7.51.0

Version of the useragent.

It's useful to use this as a second drill-down dimension with User Agent Family (ax_ua_agent_family) to get the version of the agent family.

Resource path (not including the domain) to the target service, excluding query parameters, that is defined in the proxy's <TargetEndpoint> .

For example, say an API proxy calls the following target:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

In this example, the target_basepath is /user .

If the target were this:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net</URL>
</HTTPTargetConnection>

the target_basepath would be null.

In the Debug tool , when you select the AX icon at the end of the flow diagram, the target.basepath flow variable maps to the target_basepath dimension.

HTTP response status code returned by the target service to the API proxy, such as 200 , 404 , 503 , and so on.

A value of null means the request never reached the target service. This occurs when the response is served by the ResponseCache policy or when there's a failure in request processing.

This is different from the Response Status Code (response_status_code) dimension.

Full URL of the target service defined in an API proxy's TargetEndpoint.

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

In this example, the target_url is http://mocktarget.apigee.net/user?user=Dude .

Note that the URL can also be overridden during API proxy processing with the target.url flow variable .

In proxy chaining , the target_url in the calling proxy is null.

The list of IP addresses in the X-Forwarded-For header.

To determine the original client IP Address, accessed through the ax_resolved_client_ip dimension, Apigee uses the ax_true_client_ip and the x_forwarded_for_ip dimensions.

Protocol that the client used to connect to the router. Valid values include http or https .

Based on a 24-hour clock, the 2-digit hour in which API calls were made. For example, API calls made in the hour between 10pm and 11pm, the ax_hour_of_day would be 22.

The time value is in UTC.

Currently available in Apigee orgs, not Apigee hybrid orgs.

Unix Timestamp when the fees schedule was added for the app developer and API product.

• Currency of the transaction revenue is set to the value of the currency monetization variable captured in your DataCapture policy. This currency is associated with the currency of revShareGrossPrice .
• In the context of the fees metric, it will be the currency of the setup fee, recurring fee, or prepaid top-up.

Currently available in Apigee organizations, not Apigee hybrid orgs.

The monetization rate plan for the app developer.