Application error rate example (v2)

This is an example of how to use the New Relic Data API (v2) to get your application's average error rate over a specific time period. This value appears as a percentage above the Error rate chart on your APM Summary page.

Important

While the examples utilize New Relic's REST API v2, we recommend using NRQL functions for executing metric timeslice queries. Each API value can be mapped to an equivalent NRQL function. To learn how to create NRQL queries based on these API examples, refer to our documentation.

To use the API, you need:

An API key.
Your New Relic application ID (from the URL that your browser shows from the APM user interface, or from the API Explorer user interface)

Formula

The average percentage appears above the Error rate chart on your app's Summary page. New Relic uses this formula to calculate it:

Application Error Rate = 100 * Errors/all:error_count / (HttpDispatcher:call_count + OtherTransaction/all:call_count)

API commands

To obtain the metric timeslice values, use the following three commands. This example uses the same time period for each command, and they are all summarized.

To obtain the error count:

bash

$curl -X GET "https://api.newrelic.com/v2/applications/$APP_ID/metrics/data.xml" \
>    -H "Api-Key:$API_KEY" -i \
>    -d 'names[]=Errors/all&values[]=error_count&from=2014-04-01T00:00:00+00:00&to=2014-04-01T23:35:00+00:00&summarize=true'

{
  "metric_data": {
    "from": "2014-04-01T00:00:00+00:00",
    "metrics": [
      {
        "name": "Errors/all",
        "timeslices": [
          {
            "from": "2014-04-01T00:35:00+00:00",
            "to": "2014-04-01T23:35:00+00:00",
            "values": {
              "error_count": 5
            }
          }
        ]
      }
    ],
    "metrics_found": ["Errors/all"],
    "metrics_not_found": [],
    "to": "2014-04-01T23:35:00+00:00"
  }
}

To get the HttpDispatcher call count (web application):

bash

$curl -X GET "https://api.newrelic.com/v2/applications/$APP_ID/metrics/data.xml" \
>    -H "Api-Key:$API_KEY" -i \
>    -d 'names[]=HttpDispatcher&values[]=call_count&from=2014-04-01T00:00:00+00:00&to=2014-04-01T23:35:00+00:00&summarize=true'

{
  "metric_data": {
    "from": "2014-04-01T00:00:00+00:00",
    "metrics": [
      {
        "name": "HttpDispatcher",
        "timeslices": [
          {
            "from": "2014-04-01T00:35:00+00:00",
            "to": "2014-04-01T23:35:00+00:00",
            "values": {
              "call_count": 19608
            }
          }
        ]
      }
    ],
    "metrics_found": ["HttpDispatcher"],
    "metrics_not_found": [],
    "to": "2014-04-01T23:35:00+00:00"
  }
}

To get the OtherTransaction call count (non-web app):

bash

$curl -X GET "https://api.newrelic.com/v2/applications/$APP_ID/metrics/data.xml" \
>    -H "Api-Key:$API_KEY" -i \
>    -d 'names[]=OtherTransaction/all&values[]=call_count&from=2014-04-01T00:00:00+00:00&to=2014-04-01T23:35:00+00:00&summarize=true'

{
  "metric_data": {
    "from": "2014-04-01T00:00:00+00:00",
    "metrics": [
      {
        "name": "OtherTransaction/all",
        "timeslices": [
          {
            "from": "2014-04-01T00:35:00+00:00",
            "to": "2014-04-01T23:35:00+00:00",
            "values": {
              "call_count": 4
            }
          }
        ]
      }
    ],
    "metrics_found": ["OtherTransaction/all"],
    "metrics_not_found": [],
    "to": "2014-04-01T23:35:00+00:00"
  }
}

Application error rate example (v2)

Important

Formula

API commands

Call to obtain error count

Example output from error count call

Call to obtain HttpDispatcher call count

Example output from HttpDispatcher call count call

Call to obtain OtherTransaction call count

Example output from OtherTransaction call count call

Application error rate example (v2)

Important

Formula .css-21sua1{background:none;border:none;width:0;padding:0;}

API commands

Call to obtain error count

Example output from error count call

Call to obtain HttpDispatcher call count

Example output from HttpDispatcher call count call

Call to obtain OtherTransaction call count

Example output from OtherTransaction call count call

Formula