レポートのエクスポート
レポートAPIを使用して、レポートからデータをエクスポートできます。レポートUIから、CSV、HTML、JSONまたはXML形式でレポート・データをエクスポートできます。初期エクスポート・リクエストによってデータが処理されてエクスポート・ファイルがパッケージ化され、後続のリクエストによってエクスポート済ファイルが取得されます。
ノート: 保存されたレポートに含まれるデータのみエクスポートできます。
レポート・データをエクスポートするには:
REST URLを使用してデータをエクスポートするリクエストが実行されると、ユーザー名とパスワードを入力するよう求められます。また、リクエストの実行に使用されるアプリケーションに応じて、暗号化された認可の詳細をヘッダーの一部として渡すこともできます。
ユーザー・アカウントにアカウントまたはレポートへのアクセス権がない場合は、「404, not found」エラーが表示されます。ユーザー・アカウントの設定で構成されたデータ権限は、APIエクスポートに適用されます。
- レポートを表示するとき、チャートの上のエクスポートと共有アイコン
をクリックします。
- ファイル形式として、CSV、JSON、XMLまたはHTMLを選択します。 エクスポートと共有ダイアログにInfinityのAPI REST URLが表示されます。ここで、エクスポートされたデータを取得でき、次のオプションが提示されます。
- クリップボードにコピー: 後でレポートを取得する場合や、適切なアクセス権を持つ他のユーザーとURLを共有する場合は、このオプションを選択します。
- 新しいタブで開く: REST URLを新しいブラウザ・タブに開きます。このタブでは、レポートを処理する前にユーザー名とパスワードの入力を求められます。
- 新しいタブで開くをクリックします。
- 新しいブラウザ・タブに、ユーザー名とパスワードを入力します。資格証明にアクセス権が含まれる場合は、レポートが処理中であることを示すメッセージが表示されます。エクスポートの処理時間は、リクエストされたデータ量によって異なります。処理が完了した後に、ブラウザをリフレッシュすると、エクスポートされたファイルがダウンロードされます。
- リクエストを再発行(またはリフレッシュ)して、エクスポート・ファイルをダウンロードします。
ヒント: エクスポートされたファイルの日付範囲は、ユーザー・インタフェースにレポートを表示したときの日付範囲と同じです。API REST URLを編集して、日付範囲パラメータを変更できます。
認可
レポート・データをエクスポートするには、少なくともInfinityの表示のみアクセス権が必要で、アカウント、コレクションおよびレポートへのアクセス権が必要です。REST URLを使用してデータをエクスポートするリクエストが実行されると、ユーザー名とパスワードを入力するよう求められます。ユーザー・アカウントにアカウントまたはレポートへのアクセス権がない場合は、「404, not found」エラーが表示されます。ユーザー・アカウントの設定で構成されたデータ権限は、APIエクスポートに適用されます。また、リクエストの実行に使用されるアプリケーションに応じて、暗号化された認可の詳細をヘッダーの一部として渡すこともできます。
エクスポートされる値とレポートUIが異なる場合
現在または今日の日付範囲に対してエクスポートされたレポートには、エクスポート・リクエストの開始時に使用可能なオープン・セッションが含まれます。オープン・セッションは、Infinityプラットフォームに継続的にストリーミングされ、これらのオープン・セッションはレポートUIとレポート・エクスポートの両方に表示されるため、エクスポートされたファイルはレポートUIと比較して少し異なる可能性があります。たとえば:
- 8時5分: 今週のレポートを表示します。レポートUIには、セッション値12,814が表示されます。
- 8時5分: クリックして、8時5分までのすべてのオープン・セッションを含むこのレポートのエクスポートを開始します。
- 8時8分: エクスポート・ファイルの処理が完了し、取得できる状態になりました。クリックしてファイルを開き、セッション値が12,814であることを確認します。この値は、エクスポートが最初にリクエストされた8時5分のセッション値と一致します。
- 8時10分: エクスポート・ファイルのセッション値が12,814であるのに対して、レポートUIのセッション値は13,007と表示されます。この差異は、新しいセッションがInfinityにストリーミングされた結果です。
refresh
パラメータがtrue
に設定されていないかぎり、最初のエクスポート・リクエストの2時間後に同じユーザーが同じレポートをリクエストすると、結果は同じエクスポート・ファイルになります。前述の例の場合は、9時と10時にエクスポート・リクエストを実行しても、8時5分のリクエストと同じエクスポート・ファイルが返されます。ユーザーは、最大2時間、エクスポート・ファイルを取得できます。2時間経過すると、後続のエクスポート・リクエストによって再処理され、最新のデータが取得されます。この2時間のバッファが存在するため、実行時間が長い問合せが完了して、ユーザーがエクスポート・ファイルを取得するのに十分な時間が確保されます。
refresh=true
がリクエストに追加された場合、過去2時間以内のリクエストは取り消され、新しいリクエストが開始されて、前のリクエスト以降の新しいオープン・セッションを含む最新データが取得されます。
設定およびパラメータ
次のオプションの設定とパラメータを指定して、レポート・データをフィルタできます。
タイプ | 説明 | パラメータ構文 |
---|---|---|
自動ダウンロード | 処理後に、エクスポート・ファイルを自動的にダウンロードします。true に設定すると、処理が完了したことを示すステータス・コードが返されるまでリクエストは30秒ごとに再試行され、その後、エクスポート・ファイルのダウンロードが自動的に開始されます。
|
autoDownload=[true|false]
処理の完了時にエクスポート・ファイルを自動的にダウンロードするには:
|
日付範囲 | エクスポートする日付の範囲を指定します。
または、相対的な日付範囲を指定します。 |
begin=yyyy/mm/dd/hh
2018年1月20日のデータをエクスポートするには:
2018年1月20日の8時のデータをエクスポートするには:
|
ダウンロード | エクスポートされたデータをファイルに保存してダウンロードするか、またはブラウザに直接表示するかを指定します。
|
download=[true|false]
エクスポートされたデータをファイルに保存してダウンロードするには:
エクスポートされたデータをブラウザに直接表示するには(Chromeを使用する場合のJSONおよびXML):
|
形式 | データ・エクスポート形式(CSV、HTML、JSONまたはXML)を指定します。 |
|
制限 | ディメンション・レベルごとにエクスポートする行数を指定します。
詳細は、ディメンション行の配分を参照してください。 |
limit=[1-3000000],[1-3000000],[1-3000000],...
カンマで区切られた値は、レポートの各ディメンションに適用できます。 |
リフレッシュ | 過去2時間以内の既存のリクエストを取り消し、新しいオープン・セッションを含む最新データでリクエストをリフレッシュします。
|
refresh=[true|false]
RESTリクエストをリフレッシュして最新のデータを取得するには:
前のリクエストが2時間以上前の場合、このオプション・パラメータは必要ありません。 |
相対的な日付範囲 | 今日を基準にした日付範囲を指定します。
|
|
エラー・コードの抑制 | Excelへのインポート時にエラー・コードを抑制します。これは、リクエストで200以外のHTTPステータス・コードを返されるとExcelで接続が無効になるため、Excelへのインポートで必要です。このパラメータを追加すると、すべてのエラーで200ステータス・コードがExcelに返されますが、エラーに関連付けられたメッセージ・テキストはそのまま表示されます。
|
suppressErrorCodes=[true|false]
Excelにデータをインポートするには:
|
タイム・ゾーン | タイム・ゾーンを指定します。InfinityプラットフォームではデータがUTCで格納され、タイム・ゾーンを指定するとUTCからデータがオフセットされます。 | timezone=canonical_time_zone_ID
例 所在地が米国、カリフォルニア州、ロサンゼルス(UTC - 8: 00)の場合:
所在地がフランス、パリ(UTC +1:00)の場合:
所在地がオーストラリア、メルボルン(UTC +10:00)の場合:
|
合計 | エクスポートにメジャー合計を含めるか除外するかを指定します。
|
totals=[true|false]
メジャー合計を含めるには:
メジャー合計を除外するには:
|
Excelでの値のパラメータ化
Excel内のパラメータ化されたセルをAPIリクエストのパラメータにリンクするには:
- InfinityレポートUIで、レポートをエクスポートし、クリップボードにコピーを選択します。
- Microsoft Excelを開き、「データ」>「Web から」オプションを選択します。「新しい Web クエリ」ダイアログが表示されます。
- クリップボードにコピーしたREST URLを「アドレス」に貼り付け、次のパラメータを含めるようにURLを変更します。
suppresserrorcodes=true
を追加します。format
パラメータをhtml
に変更します。download=false
を変更または追加します。autoDownload=true
を追加します。
- 「クエリの保存」をクリックします。「クエリの保存」ダイアログが表示され、保存場所を参照できます。
- IQYファイルを保存する場所のパスを入力して、「保管」をクリックします。
- IQYファイルを開き、パラメータ化された値を含めるようにREST URLを変更します。たとえば:
https://api.infinitycloud.io/v1/account/mv0nfs6p/dataexport/dtov3huh/data?begin=2017/12/26/00&end=latest&format=html&suppresserrorcodes=true&download=false&autoDownload=true
- Excelで、「データ」 > 「接続」 > 「追加」を選択し、変更したIQYファイルを選択します。
- Excelで、「既存の接続」を選択し、作成した接続をポイントします。
- IQYファイルに追加したパラメータの値を入力するよう求められ(たとえば、
begin
の値の入力など)、レポート・データがExcelに移入されます。
ディメンション行の配分
エクスポートされた行の配分をディメンション間で変更する場合は、limit
パラメータを使用すると、エクスポートされる行数をディメンション・レベルごとに指定できます。レポートの第1ディメンションのカーディナリティが低く、第2ディメンションのカーディナリティが高い(デバイス・タイプ > ページ・タイトルなど)場合は、limit
パラメータに第1ディメンションの低い値を指定して、サブディメンションの配分を大きくすることを検討してください。
エクスポートできるデータは最大3,000,000ディメンション行です。第1ディメンションは1,000行にデフォルト設定され、残りの行はレポートのサブディメンション間に配分されます。limitパラメータを使用すると、ディメンションごとにエクスポートされる行数の配分を変更できます。エクスポートされるデータは、次のデフォルト・ロジックを使用して、レポート内のディメンション間で配分されます。
レポート・ディメンションの数 | 制限 | 式 |
---|---|---|
1つ | 第1ディメンション: 1,000行に制限 | 1,000行に制限 |
2つ |
|
2つのディメンション・レポートの式: [最大行] / [第1ディメンションの制限]
例: 3,000,000 / 1,000 = 3,000 |
3つ |
|
2つのディメンション・レポートの式の平方根 [最大行] / [第1ディメンションの制限]3,000,000 / 1,000 = 3,000 3,000の平方根 = 54 |
4つ |
|
3つのディメンション・レポートの式の立方根 [最大行] / [第1ディメンションの制限] 3,000,000 / 1,000 = 3,000 3,000の立方根 = 14 |
その他の例
limit=100
: 第1ディメンションに100行がエクスポートされます。
- 2Dレポート: サブディメンションに30,000行がエクスポートされます
- 3Dレポート: サブディメンションに173行がエクスポートされます
- 4Dレポート: サブディメンションに31行がエクスポートされます
limit=5000
: 第1ディメンションに5,000行がエクスポートされます。
- 2Dレポート: サブディメンションに600行がエクスポートされます
- 3Dレポート: サブディメンションに24行がエクスポートされます
- 4Dレポート: サブディメンションに8行がエクスポートされます
limit=3000000
: 第1ディメンションに3,000,000行がエクスポートされます。
- 2Dレポート: サブディメンションに1行がエクスポートされます
- 3Dレポート: サブディメンションに1行がエクスポートされます
- 4Dレポート: サブディメンションに1行がエクスポートされます
limit=100,100
- 2Dレポート: 第1ディメンションに100行、第2ディメンションに100行がエクスポートされます
- 3Dレポート: 第1ディメンションに100行、第2ディメンションに100行、第3ディメンションに300行がエクスポートされます
- 4Dレポート: 第1ディメンションに100行、第2ディメンションに100行、第3および第4ディメンションに17行がエクスポートされます
limit=-,100
- 2Dレポート: 第1ディメンションに30,000行、第2ディメンションに100行がエクスポートされます
- 3Dレポート: 第1ディメンションに173行、第2ディメンションに100行、第3ディメンションに173行がエクスポートされます
- 4Dレポート: 第1ディメンションに31行、第2ディメンションに100行、第3および第4ディメンションに31行がエクスポートされます
limit=100,-,100
- 2Dレポート: 第1ディメンションに100行、第2ディメンションに30,000行がエクスポートされます
- 3Dレポート: 第1ディメンションに100行、第2ディメンションに300行、第3ディメンションに100行がエクスポートされます
- 4Dレポート: 第1ディメンションに100行、第2ディメンションに17行、第3ディメンションに100行、第4ディメンションに17行がエクスポートされます
limit=100,-,30,100
- 2Dレポート: 第1ディメンションに100行、第2ディメンションに30,000行がエクスポートされます
- 3Dレポート: 第1ディメンションに100行、第2ディメンションに1,000行、第3ディメンションに30行がエクスポートされます
- 4Dレポート: 第1ディメンションに100行、第2ディメンションに10行、第3ディメンションに30行、第4ディメンションに100行がエクスポートされます
limit=100,-,-,100
- 2Dレポート: 第1ディメンションに100行、第2ディメンションに30,000行がエクスポートされます
- 3Dレポート: 第1ディメンションに100行、第2ディメンションに173行、第3ディメンションに173行がエクスポートされます
- 4Dレポート: 第1ディメンションに100行、第2ディメンションに17行、第3ディメンションに17行、第4ディメンションに100行がエクスポートされます
他のディメンションの場合も同様です。