1)管理画面の「ヒートマップ登録・削除」⇒「登録」ボタンを押下。


2)以下のモーダルウィンドウが表示され、ヒートマップを導入するURLを入力し、「登録」ボタンを押下。そのあと確認アラートが表示されますが「OK」ボタンを押下。


3)登録が完了したらヒートマップ一覧に追加したURLが表示されます。


4)「Key」タブを押下すると、「ClientKey」と「ManageKey」が表示されます。導入には「ClientKey」を使用します。


5)登録したURLのファイルのheadタグ内に以下のタグを挿入してください。

-----------------------

<script src="https://js.heat-lab.net/v1/heatmap.js"></script>
<script>
HeatMapkey="[ここに上記4)の「ClientKey」を埋めてください]";
HeatMapFreeWord="[ここに任意の文字が入れることが可能です。用途は個人の特定やA/Bテストに使用できます]";
</script>
-----------------------
*)赤字部分に「ClientKey」を挿入してください

6)ヒートマップ化したいエレメントのclassにモニタリングするclass名を入力してください。

-----------------------

<div class="HeadMap_MouseMove HeadMap_MouseDown HeadMap_TouchDown HeadMap_TouchMove HeadMap_BreakAreaV HeadMap_ReadAreaV HeadMap_EndAreaV">
~~~~~ 任意のコンテンツ ~~~~~
</div">
-----------------------
*)赤字部分の機能は以下の通りです。使用者のご都合に応じて追加をしてください。
HeadMap_MouseDownユーザーがマウスをクリックすることでクリックした位置を記録します。
HeadMap_MouseMoveユーザーがマウスを動かすことでマウスの軌跡を記録します。
HeadMap_TouchDownユーザーがタップすることでタップした位置を記録します。
HeadMap_TouchMoveユーザーがスワイプすることでなぞった軌跡を記録します。
HeadMap_BreakAreaVユーザーがそのページを離れた位置を記録します
*)縦スクロールのみ有効
HeadMap_ReadAreaVユーザーがそのページを熟読したを位置を記録します
*)縦スクロールのみ有効
HeadMap_EndAreaVユーザーがそのページをどれだけスクロールしたかを記録します
*)縦スクロールのみ有効

7)導入が完了いたしましたら、早速、テストしてみてください。以下画面の右側に件数がカウントされましたら導入は成功です。


1)ヒートマップ化できる範囲には上限があります。


ヒートマップを導入するエレメントの位置がブラウザの左上から4000pxを超える場合(以下図の①②に該当)
エレメントのサイズ(width、height)が4000pxを超える場合(以下図の③④に該当)

1)ヒートマップの照会方法には以下2通りあります。

・管理画面による照会
・APIによる照会

本項は管理画面による照会を案内いたします。
*)APIによる照会を希望の方は次項に進めてください

2)管理画面の「ヒートマップ照会」を押下。右側の必須項目を入力頂いたら「ヒートマップ照会」ボタンを押下。


3)ヒートマップの照会に成功いたしますと、同画面の下部にヒートマップ情報が表示されます。


データ量に応じて処理時間がかかる場合があります。

4)検索条件にマッチするデータがない。又はヒートマップの照会の連続処理を行いますと以下の通りの画面が表示されます。


【HTTPリクエスト】

https://api.heat-lab.net/v1/GetHeatPic

【メソッド】

GET

【リクエストボディ(GETパラメータ)】

プロパティタイプ桁数
(文字数)
必須説明
url半角英数字190必須ヒートマップを照会したいURL
key半角英数字50必須「ヒートマップの導入方法」の4)にて発行したManageKey
ws半角数字4必須ヒートマップを導入したエレメントのWidthの開始幅。
0~4000の範囲を指定
we半角数字4必須ヒートマップを導入したエレメントのWidthの終了幅。
0~4000の範囲を指定
co半角英字30任意
pr半角英字30任意都道府県/州
fw半角英数字20任意フリーワード
d半角英字5必須デバイスの指定。
「PC」または「Smart」のいずれか指定
a半角英字10必須マウス/タッチ/離脱エリア/注目エリア/終了エリアの指定。
「MouseDown」「MouseMove」「TouchDown」「TouchMove」「BreakAreaV」「ReadAreaV」「EndAreaV」のいずれかを指定
bo半角数字3任意キャンバスの透過の指定。
0~100の範囲を指定
po半角数字3任意熱源の透過の指定。
0~100の範囲を指定
z半角数字190任意base64のサイズ。
10~100の範囲を指定
s日付
(YYYY-MM-DD hh:mm形式)
-任意座標データが登録された開始日付
初期値は現在日付より1ヵ月前
e日付
(YYYY-MM-DD hh:mm形式)
-任意座標データが登録された終了日付
初期値は現在日付

【レスポンス】

プロパティ返却説明
status「OK」又は「NG」「OK」:データが存在し、ヒートマップ照会ができた状態
「NG」:データが存在しない、またはレート制限にかかった状態
imgbase64(png形式)又は「Nothing」ヒートマップ化された画像がbase64として返却されます
「status」が「OK」である:base64が返却されます。
「status」が「NG」である:「Nothing」が返却されます。
count半角数字、又は「0」ヒートマップ化した件数が返却されます
「status」が「OK」である:件数が返却されます。
「status」が「NG」である:「0」が返却されます。
screenwidth半角数字bodyの幅が返却されます
「status」が「OK」である:件数が返却されます。
「status」が「NG」である:設定されません。
screenheight半角数字bodyの高さが返却されます
「status」が「OK」である:件数が返却されます。
「status」が「NG」である:設定されません。
elementwidth半角数字エレメントの幅が返却されます
「status」が「OK」である:件数が返却されます。
「status」が「NG」である:設定されません。
elementheight半角数字エレメントの高さが返却されます
「status」が「OK」である:件数が返却されます。
「status」が「NG」である:設定されません。

【HTTPリクエスト】

https://api.heat-lab.net/v1/GetHeatData

【メソッド】

GET

【リクエストボディ(GETパラメータ)】

プロパティタイプ桁数
(文字数)
必須説明
url半角英数字190必須ヒートマップを照会したいURL
key半角英数字50必須「ヒートマップの導入方法」の4)にて発行したManageKey
ws半角数字4必須ヒートマップを導入したエレメントのWidthの開始幅。
0~4000の範囲を指定
we半角数字4必須ヒートマップを導入したエレメントのWidthの終了幅。
0~4000の範囲を指定
co半角英字30任意
pr半角英字30任意都道府県/州
fw半角英数字20任意フリーワード
d半角英字5必須デバイスの指定。
「PC」または「Smart」のいずれか指定
a半角英字10必須マウス/タッチ/離脱エリア/注目エリアの指定。
「MouseDown」「MouseMove」「TouchDown」「TouchMove」「BreakAreaV」「ReadAreaV」のいずれかを指定
s日付
(YYYY-MM-DD hh:mm形式)
-任意座標データが登録された開始日付
初期値は現在日付より1ヵ月前
e日付
(YYYY-MM-DD hh:mm形式)
-任意座標データが登録された終了日付
初期値は現在日付

【レスポンス】

プロパティ返却説明
status「OK」又は「NG」「OK」:データが存在し、ヒートマップ照会ができた状態
「NG」:データが存在しない、またはレート制限にかかった状態
dataJSON又は「Nothing」
プロパティ返却説明
x自然数データの座標(横)
離脱エリアおよび注目エリアは「0」に設定されます
y自然数データの座標(縦)
range自然数データの幅
離脱エリアおよび注目エリアのみ設定されます。yが開始位置になり、そこから下への範囲を示しています
date日付データ取得時の日付
座標データをJSONとして返却されます
「status」が「OK」である:座標データが返却されます。
「status」が「NG」である:「Nothing」が返却されます。
count半角自然数、又は「0」件数が返却されます
「status」が「OK」である:件数が返却されます。
「status」が「NG」である:「0」が返却されます。

1)管理画面およびAPIなどヒートマップ照会にはレート制限があります。
かなりシビアな制限ですが、サーバーリソースの関係上、ご容赦ください。

API レート制限
GetHeatPic1リクエスト/5秒
GetHeatData1リクエスト/1秒