レポートの取得(GET /v1/reports/{report_id})

report_idで指定するレポート(統計情報)を取得します。

レポートが作成完了している場合はJSON形式でレポートを取得することができます。レポート作成処理中の場合は204 No Contentが返され、X-Statusレスポンスヘッダーがcreate_in_progressとなりますので、しばらくしてから再実行してください。

主なステータスコードとX-Message ヘッダーの値を示します。

ステータスコード X-Message 200 Success:成功しました 204 No Content:返せる内容がありません 204 Bad Request:要求が正しくありません 204 Internal Server Error:内部エラーです 204 Rate limit exceeded:要求が多すぎるため、しばらく経ってから実行してください

要求に対してエラーが生じている場合は、X-Statusレスポンスヘッダーがfailedとなりますので、X-Errorのレスポンスヘッダーも参照してください。

レポートを作成の結果、内容が0件の場合、X-Statusレスポンスヘッダーがdeployed、ステータスコード204となります。

Request Headers

を参照。

Request Parameter

report_id

取得するレポートのreport_id。

Data Type Cardinality String 1..1

Request Elements

特にありません。

Response Headers

を参照。

X-Error

エラー時の詳細情報

Data Type Cardinality String 0..1

X-Status

ステータス情報

Data Type Cardinality String 1..1

Response Elements

headers

rowsが示すレポートデータの説明情報

Data Type Cardinality Parent Element Child Element(s) String 1..n None index, name

index

レポートデータの列番号を示すインデックス(0始まり)

Data Type Cardinality Parent Element Child Element(s) Int 1..1 headers None

name

レポートデータの各列の説明

Data Type Cardinality Parent Element Child Element(s) String 1..1 headers None

rows

全レポートデータの配列表現

Data Type Cardinality Parent Element Child Element(s) String 1..n None (array)

(array)

あるTimeで示す時点とそのレポートデータを表す1行

Data Type Cardinality Parent Element Child Element(s) String 1..n rows None

metadata

レポートの作成時に指定したパラメーター。

Data Type Cardinality Parent Element Child Element(s) String 1..1 None start_date, end_date, granularity, delivery_option, time_created, metrics,service_id, per_region

granularity

レポートの作成時に指定したパラメーター。

レポートの作成のRequest Parameterを参照のこと。

Data Type Cardinality Parent Element Child Element(s) String 1..1 metadata None

start_date

レポートの作成時に指定したパラメーター。

レポートの作成のRequest Parameterを参照のこと。

Data Type Cardinality Parent Element Child Element(s) String 1..1 metadata None

end_date

レポートの作成時に指定したパラメーター。

レポートの作成のRequest Parameterを参照のこと。

Data Type Cardinality Parent Element Child Element(s) String 1..1 metadata None

delivery_option

レポートの作成時に指定したパラメーター。

レポートの作成のRequest Parameterを参照のこと。

Data Type Cardinality Parent Element Child Element(s) String 1..1 metadata None

metrics

レポートの作成時に指定したパラメーターの一覧。

レポートの作成のRequest Parameterを参照のこと。

Data Type Cardinality Parent Element Child Element(s) String 1..n metadata None

time_created

レポートを作成した日時。

Data Type Cardinality Parent Element Child Element(s) String 1..1 metadata None

service_id

配信設定を表すservice_id。レポートの作成のRequest Parameterを参照のこと。

Data Type Cardinality Parent Element Child Element(s) String 1..1 metadata None

per_region

地域毎の出力。レポートの作成のRequest Parameterを参照のこと。

Data Type Cardinality Parent Element Child Element(s) String 1..1 metadata None

Example of Response

【正常取得の場合】 GET /v1/ reports/bdf5d40b-9fc4-47d4-b569-59edf3d1f91d HTTP/1.1 200 OK X-Message: Success X-Status: deployed Content-Type: application/json Content-Length: 563 { "headers": [ { "index": 0, "name": "Time" }, { "index": 1, "name": "Region" }, { "index": 2, "name": "200Count" }, { "index": 3, "name": "RequestCount" } ], "metadata": { "delivery_option": "all", "end_date": "20160814", "granularity": "daily", "metrics": [ "200Count", "RequestCount" ], "per_region": "true", "service_id": "65a455b0-475a-42fd-b98e-75b396032bff", "start_date": "20160812", "time_created": "2016/08/23 06:22" }, "rows": [ [ "2016/08/12 00:00", "North America", "2", "2" ], [ "2016/08/12 00:00", "Japan", "1", "1" ], [ "2016/08/13 00:00", "North America", "1", "1" ] ] } 【レポートが0件の場合】 GET /v1/cdn/reports/419be4be-a30b-4af8-97db-900260ae6ad3 HTTP/1.1 204 No Content X-Message: No Content X-Status: deployed