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

データのエクスポート

さまざまな分析データには、 サイトダッシュボード個人ダッシュボードからアクセスできます。 Analytics Cloud の API を使用して分析データを取得およびエクスポートすることもできます。 具体的には、イベント データ、ID データ、個人データ、メンバーシップ データ、ページ データ、セグメント データを取得できます。

データのエクスポートをリクエストする

  1. ワークスペースのアクセストークンをメモします。 アクセス トークンを生成または取得するには、 認証 を参照してください。

  2. データリクエストは次のような形式をとります。

    curl -i -L -H "Authorization: Bearer [token]" https://analytics.liferay.com/api/reports/export/[type]?fromDate=[ISO 8601 date and time]&toDate=[ISO 8601 date and time]
    

    [token]を特定のアクセストークンに置き換えてください。 [type]イベントアイデンティティ個人メンバーシップページ、または セグメントに置き換えます。 fromDate=の後に[ISO 8601 date and time]を置き換えることで、開始日時を指定します。 toDate=の後に[ISO 8601 date and time]を置き換えることで、終了日時を指定することができます。 必ず ISO 8601 の日付と時刻形式を使用してください。 なお、リクエストには開始日時、終了日時が必要です。

    例えば、ページデータのリクエストは次のようなものです。

    curl -i -L -H "Authorization: Bearer 100dnsjvw78q2p3a5zsxxa61a0x7o8wtfx8z39z8gm2fvdq5lp7dfen" https://analytics.liferay.com/api/reports/export/page\?fromDate=2023-01-01'T'00:00:01.000'Z'\&toDate\=2023-03-01'T'23:59:59.000'Z'
    

    Windows ユーザーの場合:

    curl -i -L -H "Authorization: Bearer 100dnsjvw78q2p3a5zsxxa61a0x7o8wtfx8z39z8gm2fvdq5lp7dfen" "https://analytics.liferay.com/api/reports/export/page?fromDate=2023-01-01T00:00:01.000Z&toDate=2023-03-01T23:59:59.000Z"
    
  3. データを要求すると、次のようなメッセージが表示されます。

    {"fromDate":"2022-01-01T00:00:01.000Z","createdDate":"2022-06-29T17:50:46.824Z","toDate":"2022-01-05T23:59:59.000Z","message":"A new data export file for this date range and type will be created. Please come back later.","type":"PAGE","status":"PENDING"}%
    

    取得するデータのサイズによっては、リクエストの処理が完了するまでに数分から数時間かかる場合があります。

  4. ダウンロードの準備ができたら、エクスポート ファイルをダウンロードします。 リクエストがまだ処理中の場合は、 "後でもう一度お試しください。"、"ステータス":"保留中" というメッセージが表示されます。

    ZIP ファイルをダウンロードするには、 --output パラメータを使用します。 以下に例を示します。

    curl -L -H "Authorization: Bearer 100dnsjvw78q2p3a5zsxxa61a0x7o8wtfx8z39z8gm2fvdq5lp7dfen" https://analytics.liferay.com/api/reports/export/page\?fromDate=2023-01-01'T'00:00:01.000'Z'\&toDate\=2023-03-01'T'23:59:59.000'Z' --output foo.zip
    

    Windows ユーザーの場合:

    curl -L -H "Authorization: Bearer 100dnsjvw78q2p3a5zsxxa61a0x7o8wtfx8z39z8gm2fvdq5lp7dfen" "https://analytics.liferay.com/api/reports/export/page?fromDate=2023-01-01T00:00:01.000Z&toDate=2023-03-01T23:59:59.000Z" --output foo.zip
    

    注意: ZIP ファイルをダウンロードするときに、 -i include パラメータを使用しないでください。

    リクエストは1つずつ処理されます。 最初の要求がまだ実行されている間に 2 番目の要求が行われた場合、最初の要求の処理が完了するまで、メッセージ "ステータス":"保留中" が表示されます。

    要求されたデータは 24 時間ダウンロード可能になります。 それ以降に同じリクエストが行われた場合は、新しいリクエストとして処理されます。

ダウンロードした JSON ファイル内のデータは JSON 行 形式を使用し、各行は有効な JSON オブジェクトです。 これは、解析と読み取りが容易な柔軟な形式を提供し、 Jacksonなどのさまざまなライブラリでサポートされています。