期間の指定 (API v2)

New Relic の REST API 呼び出しで返されるデータの期間を指定できます。また、デフォルトで返される一連の値の代わりに、指定した期間の平均を返すように要求することができます。

ヒント: New Relic の REST API エクスプローラー (v2)を使っている場合は、ダイアモンドアイコン icon-api-diamondを使って、期間を選択できます。

目次

デフォルト30分の変更

API 呼び出しで使われるデフォルト期間は30分です。変更するには、from=to 値を API 呼び出しに含めてください。以下がその例です。

curl -X GET "https://api.newrelic.com/v2/applications/${APPID}/metrics/data.json" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d 'names[]=Agent/MetricsReported/count&from=2014-08-11T14:42:00+00:00&to=2014-08-11T15:12:00+00:00'

注: データ可用性には、サブスクリプションレベルで定められたデータ保持ポリシー が適用されます。

UTCのオフセット

デフォルトでは、API の時間入力には 協定世界時 (UTC) を使用しています。UTCをオフセットするには、API呼び出し内で、 プラス、マイナス 00:00 を使用してください。これにより、異なったタイムゾーンの時間を入力できるようになります。ただし、この変更をしても出力時間は変更されません。出力は常にUTCを利用します。

  • UTC の東のゾーンの場合は、マイナス記号(-)を使います。マイナス記号は HTTP では特別な意味を持ちません。
  • UTC の西のゾーンの場合は、プラス(+)をエンコードした値 %2B を使います。

例:

このAPIコールは、UTCマイナス2時間の時間帯を示している (-02:00):

curl -X GET "https://api.newrelic.com/v2/applications/${APPID}/metrics/data.json" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d 'names[]=Agent/MetricsReported/count&from=2014-08-11T14:42:00-02:00&to=2014-08-11T15:12:00-02:00'

このAPIコールはUTCプラス8時間の時間帯を示している (%2B08:00):

curl -X GET "https://api.newrelic.com/v2/applications/${APPID}/metrics/data.json" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d 'names[]=Agent/MetricsReported/count&from=2014-08-11T14:42:00%2B08:00&to=2014-08-11T15:12:00%2B08:00'

さらに詳しい情報

追加のドキュメントは以下のとおりです。