レポートAPI
Metrics API
レポートを取得する
注: Metrics APIはベータ版であり、予告なく変更されることがあります。
Get Metrics APIは、スキルの使用状況に関する数値、インサイト、高度な分析レポートを提供します。
APIのエンドポイントとヘッダー
このAPIのエンドポイントは、https://api.amazonalexa.comです。すべてのAPIリクエストにはAuthorization
ヘッダーが必要であり、その値はLogin with Amazonから取得したアクセストークンでなければなりません。
ワークフローは次のようになります。
- SMAPIと以下のリクエストを使用してリクエストを行います。
GET /v1/skills/amzn1.ask.skill.001/metrics
- 必須およびオプションのパラメーターを入力すると、Get Metrics APIはリクエストしたデータポイントの一覧を返します。
次のステップ: スプレッドシート、AWS QuickSight、AWS Redshift、またはユーザーのモニタリングシステムなどの分析ツールにレポートをアップロードできます。
ヒント: 最大1週間分の過去のレポートを取得できます。取得はデータ量によって異なります。
リクエスト
GET /v1/skills/{skillId}/metrics?startTime={startTime}&endTime={endTime}&period={period}&metric={metric}&stage={stage}
&skillType={skillType}&intent={intent}&locale={locale}&maxResults={num}&nextToken={token} HTTP/1.1
サンプルリクエスト
GET /v1/skills/amzn1.ask.skill.001/metrics?startTime=2018-11-01T10:45:00Z&endTime=2018-11-02T10:45:00Z&period=SINGLE&metric=uniqueCustomers&stage=live&skillType=custom&locale=en-US&maxResults=3&nextToken=token
リクエストのパラメーター
パラメーター | 必須 | 説明 | 位置 | 型 |
---|---|---|---|---|
skillId |
◯ | 一意のスキルIDです。 | パス | 文字列 |
startTime |
◯ | クエリの開始時刻です。 | クエリパラメーター | 文字列 |
endTime |
◯ | クエリの終了時刻です。最大期間は1週間です。 | クエリパラメーター | 文字列 |
period |
◯ | レポートを取得するときに使用される集計期間です。値はSINGLE、PT15M、PT1H、P1Dです。 | クエリパラメーター | 列挙 |
metric |
◯ | 定期的にデータセットを返す別個のロジックのセットです。レポート値の詳細については、スキルのレポート値を参照してください。 | クエリパラメーター | 列挙 |
stage |
◯ | このパラメーターは、スキルのステージを示します。有効な値は「DEVELOPMENT」または「LIVE」です。 | クエリパラメーター | 列挙 |
skillType |
◯ | スキルの種類です。有効な値は、custom、smartHome、flashBriefingです。 | クエリパラメーター | 列挙 |
intent |
✕ | スキルのインテントです。 | クエリパラメーター | 文字列 |
locale |
✕ | スキルのロケールです。 | クエリパラメーター | 文字列 |
maxResults |
✕ | 1ページに表示する結果の最大数(最大結果数は100,000)です。 | クエリパラメーター | 数値 |
nextToken |
✕ | 前回のGet Metricsレポート応答で、responseオブジェクトで返された継続トークンです。 | クエリパラメーター | 文字列 |
スキルの種類別のスキルのレポート値:
カスタムスキルのレポート値:
- uniqueCustomers
- totalEnablements
- totalUtterances
- successfulUtterances
- failedUtterances
- totalSessions
- successfulSessions
- incompleteSessions
- userEndedSessions
- skillEndedSessions
スマートホームスキルのレポート値:
- uniqueCustomers
- totalEnablements
- totalUtterances
フラッシュブリーフィングスキルのレポート値:
- uniqueCustomers
- totalEnablements
- totalSessions
応答
リクエストが成功すると、HTTP 200
が返されます。
応答本文の構造
{
"metric": "uniqueCustomers",
"timestamps": [
"2018-11-01T10:45:00Z",
"2018-11-01T10:45:00Z",
"2018-11-01T10:45:00Z"
],
"values": [
10,
20,
30
],
"nextToken": "string"
}
応答本文のフィールド
フィールド | 説明 | 型 |
---|---|---|
GetMetricDataResponse |
GetMetricDataResponse は、レポート名、タイムスタンプ、値、およびnextToken を含むオブジェクトです。 |
オブジェクト |
エラー
リクエストが失敗すると、以下のいずれかのエラーが返されます。
ステータスコード | 説明 |
---|---|
HTTP 400 |
検証エラーです。 |
HTTP 401 |
認可トークンが無効または期限切れか、リソースに対するアクセス権限がありません。 |
HTTP 403 |
リクエストされた操作は許可されていません。 |
HTTP 404 |
リクエストされたリソースが見つかりません。 |
HTTP 429 |
許可されているリクエスト制限を超えています。制限の条件には、APIごと、ClientId ごと、CustomerId ごとのリクエストの合計数があります。 |
HTTP 500 |
内部サーバーエラーです。 |
HTTP 503 |
サービスを利用できません。 |