データのクエリ
Liferay Analytics Cloudのルートエンドポイントは、 https://analytics.liferay.com/api/reportsです。 上記のURLにGETをリクエストすることで、すべてのデータタイプのエンドポイントのリストを取得することができます。 curlで試します。
この応答が返されるはずである:
ここからさまざまなAPIを呼び出して、さまざまなデータタイプのデータを取得することができる。
アナリティクスデータに対するサーバーの応答は、すべて同じデータ構造に従っています。 レスポンスは、Liferay Analytics Cloudによって計算されたエンティティのページングされた結果です。 デフォルトでは、各ページには20の要素が含まれています。 ページクエリーパラメーターを置き換えることでナビゲートできる。 合計は利用可能な要素の総数を示す。
ブログデータへのアクセス
すべてのブログデータを取得するには、このコマンドを使用します:
これらのクエリーパラメーターが利用できる:
channelId
(整数):Analytics Cloud ワークスペースのプロパティ ID。page
(整数):結果のページ番号。keywords
(文字列):アセットのタイトルにマッチするキーワード。rangeKey
(整数): データをグループ化する時間範囲。0(直近24時間のデータ)、
1(昨日のデータ)、
7(直近7日間のデータ)、
28(直近28日間のデータ)、
30(デフォルト値、直近30日間のデータ)、
90` (直近90日間のデータ) が使用可能。sortMetric
(string): データをソートするためのメトリック。指定できる値はclicksMetric
、commentsMetric
、ratingsMetric
、readingTimeMetric
、viewsMetric
である。sortOrder
(文字列): 結果を表示する順番。指定できる値はasc
またはdesc
である。
特定のブログ記事に関するデータを取得する、
ドキュメントとメディア・データへのアクセス
すべてのDocumentsとMediaデータを取得するには、このコマンドを使用します:
これらのクエリーパラメーターが利用できる:
channelId
(整数):Analytics Cloud ワークスペースのプロパティ ID。page
(整数):結果のページ番号。keywords
(文字列):データ内でマッチしたキーワード。rangeKey
(整数): データをグループ化する時間範囲。0(直近24時間のデータ)、
1(昨日のデータ)、
7(直近7日間のデータ)、
28(直近28日間のデータ)、
30(デフォルト値、直近30日間のデータ)、
90` (直近90日間のデータ) が使用可能。sortMetric
(string): データをソートするためのメトリック。指定できる値はcommentsMetric
,downloadsMetric
,previewsMetric
,ratingsMetric
である。sortOrder
(文字列): 結果を表示する順番。指定できる値はasc
またはdesc
である。
特定の文書に関するデータを取得する、
フォームデータへのアクセス
すべてのフォームデータを取得するには、このコマンドを使用します:
これらのクエリーパラメーターが利用できる:
channelId
(整数):Analytics Cloud ワークスペースのプロパティ ID。page
(整数):結果のページ番号。keywords
(文字列):データ内でマッチしたキーワード。rangeKey
(整数): データをグループ化する時間範囲。0(直近24時間のデータ)、
1(昨日のデータ)、
7(直近7日間のデータ)、
28(直近28日間のデータ)、
30(デフォルト値、直近30日間のデータ)、
90` (直近90日間のデータ) が使用可能。sortMetric
(string): データをソートするためのメトリック。指定できる値はabandonmentsMetric
、completionTimeMetric
、submissionsMetric
、viewsMetric
である。sortOrder
(文字列): 結果を表示する順番。指定できる値はasc
またはdesc
である。
特定のフォームに関するデータを取得する、
ユーザーデータへのアクセス
このコマンドを使用して、すべての個人データを取得する:
これらのクエリーパラメーターが利用できる:
channelId
(整数):Analytics Cloud ワークスペースのプロパティ ID。page
(整数):結果のページ番号。query
(文字列):個人のemailAddress
,firstName
, またはlastName
で検索された単語。
特定の個人に関する活動データを検索する、
特定の個人に関する利益データを検索する、
特定の個人に関するセグメントデータを検索する、
ページ・データへのアクセス
このコマンドを使用して、すべてのページデータを取得する:
これらのクエリーパラメーターが利用できる:
channelId
(整数):Analytics Cloud ワークスペースのプロパティ ID。page
(整数):結果のページ番号。keywords
(文字列):データ内でマッチしたキーワード。rangeKey
(整数): データをグループ化する時間範囲。0(直近24時間のデータ)、
1(昨日のデータ)、
7(直近7日間のデータ)、
28(直近28日間のデータ)、
30(デフォルト値、直近30日間のデータ)、
90` (直近90日間のデータ) が使用可能。sortMetric
(文字列): データをソートするためのメトリック。指定できる値はavgTimeOnPageMetric
,bounceMetric
,bounceRateMetric
,ctaClicksMetric
,directAccessMetric
,entrancesMetric
,exitRateMetric
,indirectAccessMetric
,readsMetric
,sessionsMetric
,timeOnPageMetric
,viewsMetric
,visitorsMetric
である。sortOrder
(string): 結果を表示する順番。指定できる値はasc
またはdesc
である。 特定のURLからページデータを取得する、
セグメントデータへのアクセス
すべてのセグメントデータを取得するには、このコマンドを使用します:
これらのクエリーパラメーターが利用できる:
channelId
(整数):Analytics Cloud ワークスペースのプロパティ ID。page
(整数):結果のページ番号。
特定のセグメントに属するすべての個人を検索する、
ウェブ・コンテンツ・データへのアクセス
すべてのウェブコンテンツのデータを取得するには、このコマンドを使用します:
これらのクエリーパラメーターが利用できる:
channelId
(整数):Analytics Cloud ワークスペースのプロパティ ID。page
(整数):結果のページ番号。keywords
(文字列):データ内でマッチしたキーワード。rangeKey
(整数): データをグループ化する時間範囲。0(直近24時間のデータ)、
1(昨日のデータ)、
7(直近7日間のデータ)、
28(直近28日間のデータ)、
30(デフォルト値、直近30日間のデータ)、
90` (直近90日間のデータ) が使用可能。sortMetric
(string): データをソートするためのメトリック。指定できる値はviewsMetric
である。sortOrder
(文字列): 結果を表示する順番。指定できる値はasc
またはdesc
である。
特定のウェブコンテンツに関するデータを取得する、