レポートAPI



レポートを取得する

Get Metrics APIは、スキルの使用状況に関する数値、インサイト、高度な分析レポートを提供します。

• レポートを取得する
• APIのエンドポイントとヘッダー
• リクエスト
  • サンプルリクエスト
  • リクエストのパラメーター
  • スキルの種類別のスキルのレポート値：
• 応答
  • 応答本文の構造
  • 応答本文のフィールド
  • エラー

APIのエンドポイントとヘッダー

このAPIのエンドポイントは、https://api.amazonalexa.comです。すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値はLogin with Amazonから取得したアクセストークンでなければなりません。

ワークフローは次のようになります。

1. SMAPIと以下のリクエストを使用してリクエストを行います。

   GET /v1/skills/amzn1.ask.skill.001/metrics
   

2. 必須およびオプションのパラメーターを入力すると、Get Metrics APIはリクエストしたデータポイントの一覧を返します。

次のステップ： スプレッドシート、AWS QuickSight、AWS Redshift、またはユーザーのモニタリングシステムなどの分析ツールにレポートをアップロードできます。

リクエスト

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

リクエストのパラメーター

スキルの種類別のスキルのレポート値：

カスタムスキルのレポート値：

• 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"
}

応答本文のフィールド

エラー

リクエストが失敗すると、以下のいずれかのエラーが返されます。