newrelic_api 1.2.3 → 1.2.4

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+1.2.4
+
+* Update docs to reflect that api.newrelic.com should be used instead of rpm.newrelic.com
+* Update gemspec with new dependencies, remove active resource dependency
+* Misc doc updates and fixes (thanks Wei Feng)
+* Force XmlFormat for compatibility with ActiveResource 3.1 (thanks Jeff Gran)
+* Update routes for metric name lookup
+* Add documentation for instances API
+* Add documentation for hosts API
+* Add documentation for servers API
+
+1.2.3
+
+* Fix XML compatibility
+
+1.2.2
+
+* Add support for querying multiple applications in the data api
+* Support for proxies (thanks to Wei Feng)
+
+1.2.1
+
+* Updated for new product names
+* Minor bugs and compatibility fixes
+
+1.2.0
+
+* Added support for metric names and metric data API
+
+1.1.2
+
+* Update deployments to support an app id # as well as app name
+* Updated documentation
+
+1.1.1
+
+* Fixes for Ruby 1.9.1 support
+
+1.1.0
+
+* Remove support for license key authentication; using api_key
+
+1.0.0
+
+* Initial versioning of the API
+* Added tests pointing at integration.newrelic.com
+

data/Gemfile

@@ -5,7 +5,7 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
-  gem 'shoulda', '~>2.10.3'
+  gem 'shoulda', '~>2.11.0'
   gem 'ci_reporter', '1.6.0'
   gem 'rdiscount'
   gem "rdoc", ">= 3.3"

data/Gemfile.lock

@@ -40,17 +40,18 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    json (1.6.1)
     little-plugger (1.1.2)
-    logging (1.6.0)
+    logging (1.6.1)
       little-plugger (>= 1.1.2)
     mail (2.2.19)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.2)
-    rack (1.2.3)
+    mime-types (1.18)
+    polyglot (0.3.3)
+    rack (1.2.5)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
@@ -68,16 +69,17 @@ GEM
       activesupport (= 3.0.7)
       rake (>= 0.8.7)
       thor (~> 0.14.4)
-    rake (0.9.2)
-    rcov (0.9.10)
+    rake (0.9.2.2)
+    rcov (0.9.11)
     rdiscount (1.6.8)
-    rdoc (3.9.4)
-    shoulda (2.10.3)
+    rdoc (3.11)
+      json (~> 1.4)
+    shoulda (2.11.3)
     thor (0.14.6)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
+    tzinfo (0.3.33)
 
 PLATFORMS
   ruby
@@ -91,4 +93,4 @@ DEPENDENCIES
   rcov
   rdiscount
   rdoc (>= 3.3)
-  shoulda (~> 2.10.3)
+  shoulda (~> 2.11.0)

data/README.rdoc

@@ -23,6 +23,12 @@ x-api-key::   API key for account, used for authentication (required)
 
     NewRelicApi.api_key = '<api key>'
 
+== Proxy Support
+
+If you are behind a proxy:
+
+    NewRelicApi.proxy = 'http://localhost:3128'
+
 == ActiveResource API
 
 The New Relic ActiveResource-based API helper is NewRelicApi.
@@ -32,12 +38,12 @@ The remainder of this document will describe our XML API.
 
 == View applications
 
-URL::            <code>https://rpm.newrelic.com/accounts/:account_id/applications.xml</code>  
+URL::            <code>https://api.newrelic.com/accounts/:account_id/applications.xml</code>  
 Method::         GET
 Restrictions::   None
 Active Resource Helper  ::  {NewRelicApi::Account}[link:NewRelicApi/Account.html]
 
-Replace <tt>:account_id</tt> with the your account number.  You can see this in the browser URL when you log in to rpm.newrelic.com.
+Replace <tt>:account_id</tt> with your account number.  You can see this in the browser URL when you log in to api.newrelic.com.
 
 === Data Returned
 
@@ -48,12 +54,12 @@ Sample data:
       <application> 
         <id type="integer">123</id> 
         <name>My Application</name> 
-        <overview-url><a href="https://rpm.newrelic.com/browser/agent?account_id=1&agent=123%3C">https://rpm.newrelic.com/browser...</a>/overview-url> 
+        <overview-url><a href="https://api.newrelic.com/browser/agent?account_id=1&agent=123%3C">https://api.newrelic.com/browser...</a>/overview-url> 
       </application> 
       <application> 
         <id type="integer">124</id> 
         <name>My Application2</name> 
-        <overview-url><a href="https://rpm.newrelic.com/browser/agent?account_id=1&agent=124%3C">https://rpm.newrelic.com/browser...</a>/overview-url> 
+        <overview-url><a href="https://api.newrelic.com/browser/agent?account_id=1&agent=124%3C">https://api.newrelic.com/browser...</a>/overview-url> 
       </application> 
     </applications> 
 
@@ -61,11 +67,149 @@ Sample data:
 
 * Invalid API Key (403)
 
+== View servers
+
+URL::            <code>https://api.newrelic.com/api/v1/accounts/:account_id/servers.xml</code>  
+Method::         GET
+Restrictions::   None
+
+Replace <tt>:account_id</tt> with your account number.  You can see this in the browser URL when you log in to api.newrelic.com.
+
+=== Data Returned
+
+Sample data:
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <servers type="array">
+      <server>
+        <overview-url>https://staging.newrelic.com/accounts/1/servers/555</overview-url>
+        <hostname>my-hostname.newrelic.com</hostname>
+        <id type="integer">555</id>
+      </server>
+      <server>
+        <overview-url>https://staging.newrelic.com/accounts/1/servers/556</overview-url>
+        <hostname>my-hostname-2.newrelic.com</hostname>
+        <id type="integer">556</id>
+      </server>
+    <server>
+
+=== Possible Error Conditions
+
+* Invalid API Key (403)
+
+== View hosts
+
+This gives you the list of hosts, so you can look up application data filtered by host.
+
+URL::            <code>https://api.newrelic.com/api/v1/accounts/:account_id/applications/:app_id/hosts.xml</code>  
+Method::         GET
+Restrictions::   None
+
+Replace <tt>:account_id</tt> with your account number, and <tt>:app_id</tt> with the application ID. You can see this in the browser URL when you log in to api.newrelic.com, or you can look up the applications using the API to view applications. JSON is also supported.
+
+=== Data Returned
+
+Sample data:
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <hosts type="array">
+      <host>
+        <overview-url>https://staging.newrelic.com/accounts/1/applications/123_h3333</overview-url>
+        <name>App name (my-hostname.newrelic.com)</name>
+        <id>123_h3333</id>
+      </host>
+    </hosts>
+
+=== Possible Error Conditions
+
+* Invalid API Key (403)
+
+
+== View instances
+
+This gives you the list of instances of your application, so you can look up application data filtered by instance. 
+
+URL::            <code>https://api.newrelic.com/api/v1/accounts/:account_id/applications/:app_id/instances.xml</code>  
+Method::         GET
+Restrictions::   None
+
+Replace <tt>:account_id</tt> with your account number, and <tt>:app_id</tt> with the application ID. You can see this in the browser URL when you log in to api.newrelic.com, or you can look up the applications using the API to view applications. JSON is also supported.
+
+=== Data Returned
+
+Sample data:
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <instances type="array">
+      <instance>
+        <overview-url>https://staging.newrelic.com/accounts/1/applications/123/instances/1441_i7584</overview-url>
+        <name>App name (my-hostname.newrelic.com)</name>
+        <id>1441_i7584</id>
+      </instance>
+    </instances>
+
+The overview URL may vary depending on the language of your application.
+
+=== Possible Error Conditions
+
+* Invalid API Key (403)
+
+
+== Delete applications
+URL::            <code>https://api.newrelic.com/api/v1/accounts/:account_id/applications/delete.xml</code>  
+Method::         POST
+Parameters::     app, a string representing the name of your application, or
+                 app_id, an integer representing the id of your application
+Replace <tt>:account_id</tt> with the your account number. You can see this in the browser URL when you log in to api.newrelic.com. 
+
+EXAMPLE 1 - Deleting an app via browser URL field
+We want to delete the app called "dotNet qa3" which has the app_id of 11068. 
+The account # is 26286. The data_access_key is the API key for this account.
+
+https://api.newrelic.com/api/v1/accounts/26286/applications/delete.xml?app_id[]=11068&data_access_key=4a249e3f3b437002efb6121844e0a4ee1d00942b18cfb9
+
+Actual response via browser:
+
+    <applications type="array">
+        <application name="dotNet qa3" id="11068">
+            <result>deleted</result>
+        </application>
+    </applications>
+
+EXAMPLE 2 - Deleting an app via Curl
+
+curl -H "x-api-key:4a249e3f3b437002efb6121844e0a4ee1d00942b18cfb9" 'https://api.newrelic.com/api/v1/accounts/26286/applications/delete.xml?app_id=11253'
+
+Actual response:
+
+    <?xml version="1.0" encoding="UTF-8"?>
+        <applications type="array">
+            <application name="test100" id="11253">
+                <result>deleted</result>
+            </application>
+    </applications>
+
+
+=== Data Returned
+
+Sample data:
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <applications type="array">
+      <application name="MyApp" id="1234">
+        <result>deleted</result>
+      </application>
+      <application name="MyApp 2" id="2345">
+        <result>failed</result>
+      </application>
+      </record>
+    </applications>
+
 == Application Summary Metrics
 
 Fetch summary metrics and threshold values (traffic light information) for one application.
 
-URL::  <code>https://rpm.newrelic.com/accounts/:account_id/applications/:app_id/threshold_values.xml</code>   Replace <tt>:account_id</tt> and <tt>:app_id</tt> with the account and application IDs.
+URL::  <code>https://api.newrelic.com/accounts/:account_id/applications/:app_id/threshold_values.xml</code>   Replace <tt>:account_id</tt> and <tt>:app_id</tt> with the account and application IDs.
 Method::    GET
 Restrictions::   This API should be called at most once per minute
 Active Resource Helper::  {NewRelicApi::Account}[link:NewRelicApi/Application.html]
@@ -96,7 +240,7 @@ Sample data:
 
 Fetch summary metrics and threshold values (traffic light information) for all applications.
 
-URL::   <code>https://rpm.newrelic.com/accounts.xml?include=application_health</code>
+URL::   <code>https://api.newrelic.com/accounts.xml?include=application_health</code>
 Method::   GET
 Restrictions::   This API should be called at most once per minute
 Active Resource Helper::  {NewRelicApi::Account}[link:NewRelicApi/Application.html]
@@ -136,9 +280,9 @@ Sample data:
 
 == Dashboard HTML fragment (All applications)
 
-New Relic provides an HTML fragment of the {dashboard view}[https://rpm.newrelic.com] of RPM. CSS styles are included, and images linked absolutely, which enables callers to embed the response directly in their applications. Authentication is through setting the appropriate API key header as outlined above, or through the regular login cookie. When using the regular login cookie, the logged-in user's default account's applications will be shown.
+New Relic provides an HTML fragment of the {dashboard view}[https://api.newrelic.com] of RPM. CSS styles are included, and images linked absolutely, which enables callers to embed the response directly in their applications. Authentication is through setting the appropriate API key header as outlined above, or through the regular login cookie. When using the regular login cookie, the logged-in user's default account's applications will be shown.
 
-URL::    <code>https://rpm.newrelic.com/application_dashboard</code>
+URL::    <code>https://api.newrelic.com/application_dashboard</code>
 Method::   GET
 Restrictions::   This API should be called at most once per minute
 Active Resource Helper::  None available currently
@@ -157,7 +301,7 @@ Sample data:
       <thead>
         <tr>
           <th class="header">Application</th>
-          <th title="Apdex Score is a industry-standard measurement of customer satisfaction. It is calculated essentially as weighted response time. The larger number is your Apdex Score, out of 1, and the smaller number is the threshold for an acceptable response time, in seconds." class="apdex">Apdex Score <a href="http://support.newrelic.com/faqs/general/apdex" target="_blank"><img alt="?" src="https://rpm.newrelic.com/images/v2/12x12/moreinfo.png?1285097852" style="border: 0px none;" /></a></th>
+          <th title="Apdex Score is a industry-standard measurement of customer satisfaction. It is calculated essentially as weighted response time. The larger number is your Apdex Score, out of 1, and the smaller number is the threshold for an acceptable response time, in seconds." class="apdex">Apdex Score <a href="http://support.newrelic.com/faqs/general/apdex" target="_blank"><img alt="?" src="https://api.newrelic.com/images/v2/12x12/moreinfo.png?1285097852" style="border: 0px none;" /></a></th>
           <th title="Response Time is the average time it took to generate a response to all requests.">Resp. Time</th>
           <th title="Errors is the percentage of your requests that received an error as a response.">Errors</th>
           <th title="Throughput is total number of requests processed by your application per minute." class="throughput last">Throughput<br>(change from <abbr title="24 hours ago">24h</abbr>/<abbr title="7 days ago">7d</abbr>)</th>
@@ -166,19 +310,19 @@ Sample data:
       <tbody class="application application_1">  
         <tr class="application_tier data">
           <td class="agent">
-            <img alt="Normal" src="https://rpm.newrelic.com/images/v2/16x16/light-green.png?1285097852" />
+            <img alt="Normal" src="https://api.newrelic.com/images/v2/16x16/light-green.png?1285097852" />
             <span class="name">
-              <a href="https://rpm.newrelic.com/accounts/1/applications/1" class="application">RPM</a>
+              <a href="https://api.newrelic.com/accounts/1/applications/1" class="application">RPM</a>
             </span>
             <span class="status reporting">1 Host and 5 Instances</span>
           </td>
           <td class="data apdex">
-            <a href="https://rpm.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dapdex">0.99<sub>0.025</sub></a>
+            <a href="https://api.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dapdex">0.99<sub>0.025</sub></a>
           </td>
-          <td class="data"><a href="https://rpm.newrelic.com/accounts/1/applications/1/transactions">5.7 ms</a></td>
-          <td class="data"><a href="https://rpm.newrelic.com/accounts/1/applications/1/traced_errors">0.00 %</a></td>
+          <td class="data"><a href="https://api.newrelic.com/accounts/1/applications/1/transactions">5.7 ms</a></td>
+          <td class="data"><a href="https://api.newrelic.com/accounts/1/applications/1/traced_errors">0.00 %</a></td>
           <td class="data throughput last">
-            <a href="https://rpm.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dthroughput">92 rpm</a>
+            <a href="https://api.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dthroughput">92 rpm</a>
             <div class="throughput_history">
               <span class="yesterday" title="Throughput down 2% from 24 hours ago"><strong class="down ">-2%</strong></span>
               <span class="last_week" title="Throughput up 0% from 7 days ago"><strong class="up ">0%</strong></span>
@@ -233,7 +377,7 @@ Sample data:
 
 == Dashboard HTML fragment (One application)
 
-URL::   <code>https://rpm.newrelic.com/application_dashboard?application_id=:id</code>   Replace <tt>:id</tt> with application ID.
+URL::   <code>https://api.newrelic.com/application_dashboard?application_id=:id</code>   Replace <tt>:id</tt> with application ID.
 Method::   GET
 Restrictions::   This API should be called at most once per minute
 Active Resource Helper::  None available currently
@@ -256,7 +400,7 @@ Sample data:
       <thead>
         <tr>
           <th class="header">Application</th>
-          <th title="Apdex Score is a industry-standard measurement of customer satisfaction. It is calculated essentially as weighted response time. The larger number is your Apdex Score, out of 1, and the smaller number is the threshold for an acceptable response time, in seconds." class="apdex">Apdex Score <a href="http://support.newrelic.com/faqs/general/apdex" target="_blank"><img alt="?" src="https://rpm.newrelic.com/images/v2/12x12/moreinfo.png?1285097852" style="border: 0px none;" /></a></th>
+          <th title="Apdex Score is a industry-standard measurement of customer satisfaction. It is calculated essentially as weighted response time. The larger number is your Apdex Score, out of 1, and the smaller number is the threshold for an acceptable response time, in seconds." class="apdex">Apdex Score <a href="http://support.newrelic.com/faqs/general/apdex" target="_blank"><img alt="?" src="https://api.newrelic.com/images/v2/12x12/moreinfo.png?1285097852" style="border: 0px none;" /></a></th>
           <th title="Response Time is the average time it took to generate a response to all requests.">Resp. Time</th>
           <th title="Errors is the percentage of your requests that received an error as a response.">Errors</th>
           <th title="Throughput is total number of requests processed by your application per minute." class="throughput last">Throughput<br>(change from <abbr title="24 hours ago">24h</abbr>/<abbr title="7 days ago">7d</abbr>)</th>
@@ -265,19 +409,19 @@ Sample data:
       <tbody class="application application_1">  
         <tr class="application_tier data">
           <td class="agent">
-            <img alt="Normal" src="https://rpm.newrelic.com/images/v2/16x16/light-green.png?1285097852" />
+            <img alt="Normal" src="https://api.newrelic.com/images/v2/16x16/light-green.png?1285097852" />
             <span class="name">
-              <a href="https://rpm.newrelic.com/accounts/1/applications/1" class="application">RPM</a>
+              <a href="https://api.newrelic.com/accounts/1/applications/1" class="application">RPM</a>
             </span>
             <span class="status reporting">1 Host and 5 Instances</span>
           </td>
           <td class="data apdex">
-            <a href="https://rpm.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dapdex">0.99<sub>0.025</sub></a>
+            <a href="https://api.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dapdex">0.99<sub>0.025</sub></a>
           </td>
-          <td class="data"><a href="https://rpm.newrelic.com/accounts/1/applications/1/transactions">5.7 ms</a></td>
-          <td class="data"><a href="https://rpm.newrelic.com/accounts/1/applications/1/traced_errors">0.00 %</a></td>
+          <td class="data"><a href="https://api.newrelic.com/accounts/1/applications/1/transactions">5.7 ms</a></td>
+          <td class="data"><a href="https://api.newrelic.com/accounts/1/applications/1/traced_errors">0.00 %</a></td>
           <td class="data throughput last">
-            <a href="https://rpm.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dthroughput">92 rpm</a>
+            <a href="https://api.newrelic.com/accounts/1/applications/1/transactions#sort_by%3Dthroughput">92 rpm</a>
             <div class="throughput_history">
               <span class="yesterday" title="Throughput down 2% from 24 hours ago"><strong class="down ">-2%</strong></span>
               <span class="last_week" title="Throughput up 0% from 7 days ago"><strong class="up ">0%</strong></span>
@@ -334,7 +478,7 @@ Sample data:
 
 Unlike other API requests, the deployments API will accept either a license key (in the +x-license-key+ header) or an API key (in the +x-api-key+ header).  Furthermore, when using the license key, you do not need to enable the API in the account settings.  This is the standard mechanism used by the agent to upload deployments from the built in capistrano recipes.
 
-URL::      <code>https://rpm.newrelic.com/deployments.xml</code>
+URL::      <code>https://api.newrelic.com/deployments.xml</code>
 Method::   POST
 Active Resource Helper::  {NewRelicApi::Account}[link:NewRelicApi/Deployment.html]
 
@@ -356,26 +500,25 @@ The optional fields may be set to anything you wish, and are not validated. For
 
 Here's an example using <tt>curl</tt>:
 
-    curl -H "x-api-key:YOUR_API_KEY_HERE" -d "deployment[app_name]=iMyFace.ly Production" https://rpm.newrelic.com/deployments.xml
+    curl -H "x-api-key:YOUR_API_KEY_HERE" -d "deployment[app_name]=iMyFace.ly Production" https://api.newrelic.com/deployments.xml
   
 If you were to specify the optional <tt>description</tt>, <tt>changelog</tt> and <tt>user</tt> fields, the command would look like this:
   
-    curl -H "x-api-key:YOUR_API_KEY_HERE" -d "deployment[app_name]=iMyFace.ly Production" -d "deployment[description]=This deployment was sent using curl" -d "deployment[changelog]=many hands make light work" -d "deployment[user]=Joe User" https://rpm.newrelic.com/deployments.xml
+    curl -H "x-api-key:YOUR_API_KEY_HERE" -d "deployment[app_name]=iMyFace.ly Production" -d "deployment[description]=This deployment was sent using curl" -d "deployment[changelog]=many hands make light work" -d "deployment[user]=Joe User" https://api.newrelic.com/deployments.xml
 
 == Metric Names
 
 Fetches all metrics for an application, or allows you to use a regular expression to get a subset of the metrics. These metrics are used to retrieve metric values from the Metric Data API (below). Each metric is returned with a list of fields that are valid for that metric. 
 
-URL::  <code>https://api.newrelic.com/api/v1/applications/:app_id/metrics.:format</code>   Replace +:app_id+ and +:format+ with the application ID and for format use one of (+json+, +xml+, +csv+).
+URL::  <code>https://api.newrelic.com/api/v1/agents/:agent_id/metrics.:format</code>   Replace +:format+ with the one of (+json+, +xml+, +csv+). +:agent_id+ is either an application ID, server ID, host ID, or instance ID, from the APIs documented above. 
 Method::    GET
 Restrictions::   This API should be called at most once per minute.
 
 For partner admins, you can use a slightly different URL to get metric names for your customers (requires partner permissions).
 
-URL::  <code>https://api.newrelic.com/api/v1/accounts/:account_id/applications/:app_id/metrics.:format</code>   Replace +:account_id+ with the account ID of the customer, +:app_id+ with the application ID for the customer, and +:format+ with one of (+json+, +xml+, +csv+).
+URL::  <code>https://api.newrelic.com/api/v1/accounts/:account_id/agents/:agent_id/metrics.:format</code>   Replace +:account_id+ with the account ID of the customer, +:agent_id+ with the application, server, host, or instance ID for the customer, and +:format+ with one of (+json+, +xml+, +csv+).
 Method::    GET
-Restrictions::   This API should be called at most once per minute.
-
+Restrictions::   This API should be called at most once per minute. 
 
 === Request Parameters
 
@@ -388,7 +531,7 @@ Note: Metric names will only be returned to Pro customers.
 
 Sample requests:
 
-https://api.newrelic.com/api/v1/applications/APPLICATION_ID/metrics.xml?re=WebTransaction&limit=2
+https://api.newrelic.com/api/v1/agents/:agent_id/metrics.xml?re=WebTransaction&limit=2
 
 Sample data:
 
@@ -465,20 +608,20 @@ Apdex metrics support a particular set of fields:
 
 Returns the data values for metrics collected by New Relic for your application. You can use this API to build your own view of almost any metric data tracked by New Relic. 
 
-URL::  <code>https://api.newrelic.com/api/v1/accounts/:account_id/data.:format</code>   Replace +:account_id+ and +:format+ with your New Relic account ID (found in the URL when you access New Relic), and for format use one of (+json+, +xml+, +csv+).
+URL::  <code>https://api.newrelic.com/api/v1/accounts/:account_id/metrics/data.:format</code>   Replace +:account_id+ and +:format+ with your New Relic account ID (found in the URL when you access New Relic), and for format use one of (+json+, +xml+, +csv+).
 Method::    GET
 Restrictions::   This API is rate-limited per minute, and the limit is subject to change at any point.
 
 For partner admins, you can use a slightly different URL to get metric data for your customers (requires partner permissions).
 
-URL::  <code>https://api.newrelic.com/api/v1/accounts/:account_id/applications/:app_id/data.:format</code>   Replace +:account_id+ with the account ID of the customer, +:app_id+ with the application ID for the customer, and +:format+ with one of (+json+, +xml+, +csv+).
+URL::  <code>https://api.newrelic.com/api/v1/accounts/:account_id/agents/:agent_id/data.:format</code>   Replace +:account_id+ with the account ID of the customer, +:agent_id+ with the application, server, host, or instance ID for the customer, and +:format+ with one of (+json+, +xml+, +csv+).
 Method::    GET
 Restrictions::   This API is rate-limited per minute, and the limit is subject to change at any point.
 
 
 === Request Parameters
 
-* +app+ or +app_id+: Application name, or application ID, respectively. The application name must be an exact match. You can pass in an array of apps to query by specifying app[]=First&app[]=Second or app_id[]=1234&app_id[]=2345
+* +app+ or +agent_id+: Application name, or agent ID, respectively. The application name must be an exact match. You can pass in an array of apps to query by specifying app[]=First&app[]=Second . The agent_id is either an ID for an application, an instance, a server, or a host. You can look each of these up using our API (see documentation above for "view applications", "view servers", "view hosts", "view instances"). You can query multiple agents at the same time, but they must all be of the same type: application, instance, server, or host. Examples: agent_id[]=1234&agent_id[]=2345 (for applications), agent_id[]=1441_i7584&agent_id[]=1441_i7588 (for instances), agent_id[]=123_h3333&agent_id[]=123_h3388 (for host filtered application data), agent_id[]=555&agent_id[]=556 (for server data)
 * +begin+: Begin time, in XML UTC format. For example: <tt>2011-04-20T15:47:00Z</tt> (note that the New Relic site graphs are NOT in UTC format, so when comparing results, be sure to convert)
 * +end+: End time, in XML UTC format. For example: <tt>2011-04-20T15:52:00Z</tt>
 * +metrics+: Included one or many times, this lists the metrics you are interested in. If you specify multiple metrics, the request parameter should look like <tt>metrics[]=foo&metrics[]=bar</tt> (append '[]' to the end of the name of the parameter). You can specify <tt>metrics[]</tt> even if there is a single metric.
@@ -491,7 +634,7 @@ Note: Metric data will only be returned to Pro customers.
 
 Sample time series request:
 
-https://api.newrelic.com/api/v1/accounts/ACCOUNT_ID/data.xml?begin=2011-04-20T15:47:19Z&end=2011-04-20T15:52:19Z&metrics[]=ActiveRecord/all&field=average_response_time&app=My%20Application
+https://api.newrelic.com/api/v1/accounts/:account_id/metrics/data.xml?begin=2011-04-20T15:47:19Z&end=2011-04-20T15:52:19Z&metrics[]=ActiveRecord/all&field=average_response_time&app=My%20Application
 
 Sample time series data:
 
@@ -516,7 +659,7 @@ Sample time series data:
 
 Sample summary request:
 
-https://api.newrelic.com/api/v1/accounts/ACCOUNT_ID/data.xml?begin=2011-04-20T15:47:19Z&end=2011-04-20T15:52:19Z&metrics[]=ActiveRecord/all&field=average_response_time&app=My%20Application&summary=1
+https://api.newrelic.com/api/v1/accounts/:account_id/metrics/data.xml?begin=2011-04-20T15:47:19Z&end=2011-04-20T15:52:19Z&metrics[]=ActiveRecord/all&field=average_response_time&app=My%20Application&summary=1
 
 Sample summary data:
 
@@ -535,5 +678,5 @@ Sample summary data:
 
 == Copyright
 
-Copyright (c) 2011 New Relic, Inc.
+Copyright (c) 2012 New Relic, Inc.
 

data/Rakefile

@@ -12,9 +12,11 @@ require 'jeweler'
 require 'rdiscount'
 
 require 'ci/reporter/rake/test_unit'
+API_VERSION = File.read('CHANGELOG.md')[/^.*$/]
 TITLE = %Q{Documentation and helper code for the New Relic API}
-RDOC_FILES=['README*', 'CHANGELOG', 'sample*']
+RDOC_FILES=Dir['README*', 'CHANGELOG*', 'sample*']
 Jeweler::Tasks.new do |gem|
+  gem.version = API_VERSION
   gem.name = "newrelic_api"
   gem.homepage = "http://www.github.com/newrelic/newrelic_api"
   gem.license = "MIT"
@@ -48,9 +50,9 @@ task :default => :test
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = TITLE
+  # I don't know why, but the next line has no effect
   rdoc.rdoc_files.include(*RDOC_FILES)
   rdoc.rdoc_files.include('lib/**/*.rb')
   rdoc.main = "README.rdoc"

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.2.4

data/lib/new_relic_api.rb

@@ -1,3 +1,4 @@
+require 'active_resource'
 require 'active_resource_associations'
 
 # = New Relic REST API
@@ -74,6 +75,7 @@ module NewRelicApi
         NewRelicApi.proxy
       end
     end
+    self.format = ActiveResource::Formats::XmlFormat
     self.site = self.site_url
     self.proxy = self.proxy
   end

data/lib/newrelic_api.rb

@@ -0,0 +1 @@
+require 'new_relic_api'

data/newrelic_api.gemspec

@@ -4,21 +4,20 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{newrelic_api}
-  s.version = "1.2.1"
+  s.name = "newrelic_api"
+  s.version = "1.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["New Relic"]
-  s.date = %q{2011-09-07}
-  s.description = %q{Use this gem to access New Relic application information via a REST api}
-  s.email = %q{support@newrelic.com}
+  s.date = "2012-05-24"
+  s.description = "Use this gem to access New Relic application information via a REST api"
+  s.email = "support@newrelic.com"
   s.extra_rdoc_files = [
-    "CHANGELOG",
+    "CHANGELOG.md",
     "README.rdoc"
   ]
   s.files = [
-    ".project",
-    "CHANGELOG",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -27,16 +26,17 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/active_resource_associations.rb",
     "lib/new_relic_api.rb",
+    "lib/newrelic_api.rb",
     "newrelic_api.gemspec",
     "test/integration/newrelic_api_test.rb",
     "test/test_helper.rb"
   ]
-  s.homepage = %q{http://www.github.com/newrelic/newrelic_api}
+  s.homepage = "http://www.github.com/newrelic/newrelic_api"
   s.licenses = ["MIT"]
   s.rdoc_options = ["--line-numbers", "--title", "Documentation and helper code for the New Relic API", "-m", "README.rdoc"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Documentation and helper code for the New Relic API}
+  s.rubygems_version = "1.8.24"
+  s.summary = "Documentation and helper code for the New Relic API"
   s.test_files = [
     "test/integration/newrelic_api_test.rb",
     "test/test_helper.rb"
@@ -50,7 +50,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, ["~> 2.10.3"])
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11.0"])
       s.add_development_dependency(%q<ci_reporter>, ["= 1.6.0"])
       s.add_development_dependency(%q<rdiscount>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 3.3"])
@@ -60,7 +60,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<shoulda>, ["~> 2.10.3"])
+      s.add_dependency(%q<shoulda>, ["~> 2.11.0"])
       s.add_dependency(%q<ci_reporter>, ["= 1.6.0"])
       s.add_dependency(%q<rdiscount>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 3.3"])
@@ -71,7 +71,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<shoulda>, ["~> 2.10.3"])
+    s.add_dependency(%q<shoulda>, ["~> 2.11.0"])
     s.add_dependency(%q<ci_reporter>, ["= 1.6.0"])
     s.add_dependency(%q<rdiscount>, [">= 0"])
     s.add_dependency(%q<rdoc>, [">= 3.3"])

data/test/integration/newrelic_api_test.rb

@@ -51,8 +51,7 @@ class NewrelicApiTest < ActiveSupport::TestCase
     check_applications(apps)
     ui_app = apps.first
 
-    # Unfortunately, if you ask for a non-existent app, you get a redirect right now.
-    assert_raises ActiveResource::Redirection do
+    assert_raises ActiveResource::ResourceNotFound do
       account.applications(9999)
     end
 

data/test/test_helper.rb

@@ -23,6 +23,7 @@ require 'shoulda'
 require 'logging'
 
 $LOAD_PATH << File.expand_path("../../lib", __FILE__)
+Dir.mkdir "log" unless File.directory? "log"
 ActiveResource::Base.logger = Logger.new(File.expand_path('../../log/test.log', __FILE__))
 ActiveResource::Base.logger.level = Logger::DEBUG
 class ActiveSupport::TestCase

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: newrelic_api
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 1
   - 2
-  - 3
-  version: 1.2.3
+  - 4
+  version: 1.2.4
 platform: ruby
 authors: 
 - New Relic
@@ -15,13 +15,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-07 00:00:00 -07:00
-default_executable: 
+date: 2012-05-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: rails
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -34,10 +30,10 @@ dependencies:
         - 7
         version: 3.0.7
   requirement: *id001
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: rails
   type: :development
-  name: bundler
+- !ruby/object:Gem::Dependency 
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -50,10 +46,10 @@ dependencies:
         - 0
         version: 1.0.0
   requirement: *id002
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: bundler
   type: :development
-  name: jeweler
+- !ruby/object:Gem::Dependency 
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -66,10 +62,10 @@ dependencies:
         - 2
         version: 1.5.2
   requirement: *id003
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: jeweler
   type: :development
-  name: rcov
+- !ruby/object:Gem::Dependency 
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -80,26 +76,26 @@ dependencies:
         - 0
         version: "0"
   requirement: *id004
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: rcov
   type: :development
-  name: shoulda
+- !ruby/object:Gem::Dependency 
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 33
+        hash: 35
         segments: 
         - 2
-        - 10
-        - 3
-        version: 2.10.3
+        - 11
+        - 0
+        version: 2.11.0
   requirement: *id005
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: shoulda
   type: :development
-  name: ci_reporter
+- !ruby/object:Gem::Dependency 
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -112,10 +108,10 @@ dependencies:
         - 0
         version: 1.6.0
   requirement: *id006
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: ci_reporter
   type: :development
-  name: rdiscount
+- !ruby/object:Gem::Dependency 
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -126,10 +122,10 @@ dependencies:
         - 0
         version: "0"
   requirement: *id007
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: rdiscount
   type: :development
-  name: rdoc
+- !ruby/object:Gem::Dependency 
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -141,10 +137,10 @@ dependencies:
         - 3
         version: "3.3"
   requirement: *id008
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: rdoc
   type: :development
-  name: logging
+- !ruby/object:Gem::Dependency 
   version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -155,6 +151,9 @@ dependencies:
         - 0
         version: "0"
   requirement: *id009
+  prerelease: false
+  name: logging
+  type: :development
 description: Use this gem to access New Relic application information via a REST api
 email: support@newrelic.com
 executables: []
@@ -162,11 +161,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- CHANGELOG
+- CHANGELOG.md
 - README.rdoc
 files: 
-- .project
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -175,10 +173,10 @@ files:
 - VERSION
 - lib/active_resource_associations.rb
 - lib/new_relic_api.rb
+- lib/newrelic_api.rb
 - newrelic_api.gemspec
 - test/integration/newrelic_api_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://www.github.com/newrelic/newrelic_api
 licenses: 
 - MIT
@@ -212,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Documentation and helper code for the New Relic API

data/.project

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
-	<name>API Gem</name>
-	<comment></comment>
-	<projects>
-	</projects>
-	<buildSpec>
-		<buildCommand>
-			<name>org.rubypeople.rdt.core.rubybuilder</name>
-			<arguments>
-			</arguments>
-		</buildCommand>
-	</buildSpec>
-	<natures>
-		<nature>org.rubypeople.rdt.core.rubynature</nature>
-	</natures>
-</projectDescription>

data/CHANGELOG

@@ -1,20 +0,0 @@
-1.0.0
-  - Initial versioning of the API
-  - Added tests pointing at integration.newrelic.com
-1.1.0
-  - Remove support for license key authentication; using api_key
-1.1.1
-  - Fixes for Ruby 1.9.1 support
-1.1.2
-  - Update deployments to support an app id # as well as app name
-  - Updated documentation
-1.2.0
-  - Added support for metric names and metric data API
-1.2.1
-  - Updated for new product names
-  - Minor bugs and compatibility fixes
-1.2.2
-  - Add support for querying multiple applications in the data api
-  - Support for proxies (thanks to Wei Feng)
-1.2.3
-  - Fix XML compatibility