ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

データのクエリ

Liferay Analytics Cloudのルートエンドポイントは、 https://analytics.liferay.com/api/reportsです。上記のURLにGETをリクエストすることで、すべてのデータタイプのエンドポイントのリストを取得することができます。 curlで試します。

curl -i -L -H "Authorization: Bearer {token}" https://analytics.liferay.com/api/reports

次の応答が返されるはずです:

{
   "_links":{
        "blogs": {
            "href": "https://analytics.liferay.com/api/reports/blogs{?channelId,page,keywords,rangeKey,sortMetric,sortOrder}",
            "templated": true
        },
        "documents-and-media": {
            "href": "https://analytics.liferay.com/api/reports/documents-and-media{?channelId,page,keywords,rangeKey,sortMetric,sortOrder}",
            "templated": true
        },
        "forms": {
            "href": "https://analytics.liferay.com/api/reports/forms{?channelId,page,keywords,rangeKey,sortMetric,sortOrder}",
            "templated": true
        },
        "individuals": {
            "href": "https://analytics.liferay.com/api/reports/individuals{?channelId,page,query}",
            "templated": true
        },
        "pages": {
            "href": "https://analytics.liferay.com/api/reports/pages{?channelId,page,keywords,rangeKey,sortMetric,sortOrder}",
            "templated": true
        },
        "segments": {
            "href": "https://analytics.liferay.com/api/reports/segments{?channelId,page}",
            "templated": true
        },
        "web-contents": {
            "href": "https://analytics.liferay.com/api/reports/web-contents{?channelId,page,keywords,rangeKey,sortMetric,sortOrder}",
            "templated": true
        }
   }
}

ここからさまざまな API を呼び出して、さまざまなデータ型のデータを取得できます。

アナリティクスデータに対するサーバーの応答は、すべて同じデータ構造に従っています。レスポンスは、Liferay Analytics Cloud によって計算されたエンティティのページ化された結果です。デフォルトでは、各ページには 20 個の要素が含まれます。ページクエリパラメータを置き換えることでナビゲートできます。合計には、利用可能な要素の合計数が表示されます。

ブログデータへのアクセス

すべてのブログデータを取得するには、次のコマンドを使用します。

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/blogs

使用可能なクエリパラメータは次のとおりです。

channelId (整数): Analytics Cloud ワークスペースプロパティ ID。
ページ (整数): 結果のページ番号。
キーワード (文字列): アセットのタイトル内で一致したキーワード。
rangeKey (整数): データをグループ化する時間範囲。可能な値は、 0 (過去 24 時間のデータ)、 1 (昨日のデータ)、 7 (過去 7 日間のデータ)、 28 (過去 28 日間のデータ)、 30 (デフォルト値、過去 30 日間のデータ)、 90 (過去 90 日間のデータ) です。
sortMetric(文字列): データをソートするためのメトリック。可能な値は、 clicksMetric、 commentsMetric、 ratingsMetric、 readingTimeMetric、 viewsMetricです。
sortOrder (文字列): 結果を表示する順序。可能な値は asc または descです。

特定のブログ投稿に関するデータを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/blogs/{blogID}

ドキュメントとメディアデータへのアクセス

すべてのドキュメントとメディアデータを取得するには、このコマンドを使用します。

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/documents-and-media

使用可能なクエリパラメータは次のとおりです。

channelId (整数): Analytics Cloud ワークスペースプロパティ ID。
ページ (整数): 結果のページ番号。
キーワード (文字列): データ内で一致したキーワード。
rangeKey (整数): データをグループ化する時間範囲。可能な値は、 0 (過去 24 時間のデータ)、 1 (昨日のデータ)、 7 (過去 7 日間のデータ)、 28 (過去 28 日間のデータ)、 30 (デフォルト値、過去 30 日間のデータ)、 90 (過去 90 日間のデータ) です。
sortMetric(文字列): データをソートするためのメトリック。可能な値は、 commentsMetric、 downloadsMetric、 previewsMetric、 ratingsMetricsです。
sortOrder (文字列): 結果を表示する順序。可能な値は asc または descです。

特定の文書に関するデータを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/documents-and-media/{documentId}

フォームデータへのアクセス

すべてのフォームデータを取得するには、次のコマンドを使用します。

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/forms

使用可能なクエリパラメータは次のとおりです。

channelId (整数): Analytics Cloud ワークスペースプロパティ ID。
ページ (整数): 結果のページ番号。
キーワード (文字列): データ内で一致したキーワード。
rangeKey (整数): データをグループ化する時間範囲。可能な値は、 0 (過去 24 時間のデータ)、 1 (昨日のデータ)、 7 (過去 7 日間のデータ)、 28 (過去 28 日間のデータ)、 30 (デフォルト値、過去 30 日間のデータ)、 90 (過去 90 日間のデータ) です。
sortMetric(文字列): データをソートするためのメトリック。可能な値は、 abandonmentsMetric、 completionTimeMetric、 submissionsMetric、 viewsMetricです。
sortOrder (文字列): 結果を表示する順序。可能な値は asc または descです。

特定のフォームに関するデータを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/forms/{formId}

ユーザーデータへのアクセス

すべての個人データを取得するには、このコマンドを使用します。

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/individuals

使用可能なクエリパラメータは次のとおりです。

channelId (整数): Analytics Cloud ワークスペースプロパティ ID。
ページ (整数): 結果のページ番号。
query (文字列): 個人の emailAddress、 firstName、または lastNameで検索される任意の単語。

特定の個人の活動データを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/individuals/{individualsId}/activities

特定の個人の興味データを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/individuals/{individualsId}/interests

特定の個人のセグメントデータを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/individuals/{individualsId}/segments

ページデータへのアクセス

すべてのページデータを取得するには、次のコマンドを使用します。

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/pages

使用可能なクエリパラメータは次のとおりです。

channelId (整数): Analytics Cloud ワークスペースプロパティ ID。
ページ (整数): 結果のページ番号。
キーワード (文字列): データ内で一致したキーワード。
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、 visitorMetric。
sortOrder (文字列): 結果を表示する順序。可能な値は asc または descです。

特定のURLからページデータを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/pages/{pageURL}

セグメントデータへのアクセス

すべてのセグメントデータを取得するには、次のコマンドを使用します。

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/segments

使用可能なクエリパラメータは次のとおりです。

channelId (整数): Analytics Cloud ワークスペースプロパティ ID。
ページ (整数): 結果のページ番号。

特定のセグメントの個体をすべて取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/segments/{segmentsId}/individuals

Webコンテンツデータへのアクセス

すべての Web コンテンツデータを取得するには、次のコマンドを使用します。

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/web-contents

使用可能なクエリパラメータは次のとおりです。

channelId (整数): Analytics Cloud ワークスペースプロパティ ID。
ページ (整数): 結果のページ番号。
キーワード (文字列): データ内で一致したキーワード。
rangeKey (整数): データをグループ化する時間範囲。可能な値は、 0 (過去 24 時間のデータ)、 1 (昨日のデータ)、 7 (過去 7 日間のデータ)、 28 (過去 28 日間のデータ)、 30 (デフォルト値、過去 30 日間のデータ)、 90 (過去 90 日間のデータ) です。
sortMetric(文字列): データをソートするためのメトリック。可能な値は viewsMetricです。
sortOrder (文字列): 結果を表示する順序。可能な値は asc または descです。

特定のウェブコンテンツに関するデータを取得するには、

curl -i -L -H "Authorization: Bearer {token}" -L https://analytics.liferay.com/api/reports/web-contents/{webContentsID}

Capability:

Cloud

Resource Type:

Official Documentation

Feature:

Analytics Cloud Administration

Deployment Approach:

Liferay PaaS

Liferay SaaS

Liferay Self-Hosted