SMPのWebトラッキングセッション履歴情報を参照するためのAPIです。
visitor.getTrackingsession
| メソッド | URL |
|---|---|
| GET | https://{domainname}/services/rest/visitor/trackingsession |
| パラメータ名 | 必須 | 内容 |
|---|---|---|
| search_key{cid} | オプション | 検索条件のキー項目 指定可能なキー項目は下記「検索条件に指定可能なカラム」参照 |
| search_operator{cid} | オプション | “検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like” |
| search_value{cid} | オプション | 検索値 Nullを指定する場合は、何も指定しません。 例: search_value1= |
| order | オプション | 並び順の項目 指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照 |
| direction | オプション | 並び順を指定する 「asc」(昇順)または「desc」(降順) |
| limit | オプション | 1回のリクエストで取得するレコード数 (最大1000) |
| offset | オプション | レコードのオフセット |
| カラム名 | 検索条件 | 並び順 | 内容 |
|---|---|---|---|
| Id | ○ | ○ | トラッキングセッション履歴ID |
| VisitorId | ○ | ○ | リードID |
| SessionId | ○ | ○ | トラッキングセッションID |
| SearchEngine | ○ | ○ | 検索エンジン(流入元) |
| SearchWord | ○ | ○ | 検索ワード |
| Conversion ※非推奨カラムです。 |
○ | ○ | コンバージョン |
| StartTime | ○ | ○ | トラッキング日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| ClickCountUrlId | ○ | × | クリックカウントURL ID |
| PageCount | ○ | ○ | 閲覧回数 |
| DateUpdate | ○ | ○ | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| RemoteIp | ○ | ○ | アクセス元IPアドレス |
| UserAgent | ○ | ○ | ユーザーエージェント |
| CamsField1 | ○ | ○ | カスタムフィールド |
| CamsField2 | ○ | ○ | カスタムフィールド |
| CamsField3 | ○ | ○ | カスタムフィールド |
| CamsField4 | ○ | ○ | カスタムフィールド |
| CamsField5 | ○ | ○ | カスタムフィールド |
| CamsField6 | ○ | ○ | カスタムフィールド |
| CamsField7 | ○ | ○ | カスタムフィールド |
| CamsField8 | ○ | ○ | カスタムフィールド |
| CamsField9 | ○ | ○ | カスタムフィールド |
| CamsField10 | ○ | ○ | カスタムフィールド |
| CamsField11 | ○ | ○ | カスタムフィールド |
| CamsField12 | ○ | ○ | カスタムフィールド |
| CamsField13 | ○ | ○ | カスタムフィールド |
| CamsField14 | ○ | ○ | カスタムフィールド |
| CamsField15 | ○ | ○ | カスタムフィールド |
| CamsField16 | ○ | ○ | カスタムフィールド |
| CamsField17 | ○ | ○ | カスタムフィールド |
| CamsField18 | ○ | ○ | カスタムフィールド |
| CamsField19 | ○ | ○ | カスタムフィールド |
| CamsField20 | ○ | ○ | カスタムフィールド |
なし
なし
| コード | 内容 |
|---|---|
| 200 | 正常終了 |
なし
★ エレメント名:TrackingSession ★ データ型:TrackingSessionType
| カラム名 | データ型 | 内容 |
|---|---|---|
| Id | string | トラッキングセッション履歴ID |
| VisitorId | string | リードID |
| SessionId | string | トラッキングセッションID |
| SearchEngine | string | 検索エンジン(流入元) |
| SearchWord | string | 検索ワード |
| Conversion ※非推奨カラムです。 |
string | コンバージョン |
| StartTime | dateTime | トラッキング日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| ClickCountUrlId | string | クリックカウントURL ID |
| PageCount | nonNegativeInteger | 閲覧回数 |
| SojournTime | string | 滞在時間 |
| SojournSecond | string | 滞在時間(秒数) |
| DateUpdate | dateTime | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| RemoteIp | string | アクセス元IPアドレス |
| UserAgent | string | ユーザーエージェント |
| CamsField1 | string | カスタムフィールド |
| CamsField2 | string | カスタムフィールド |
| CamsField3 | string | カスタムフィールド |
| CamsField4 | string | カスタムフィールド |
| CamsField5 | string | カスタムフィールド |
| CamsField6 | string | カスタムフィールド |
| CamsField7 | string | カスタムフィールド |
| CamsField8 | string | カスタムフィールド |
| CamsField9 | string | カスタムフィールド |
| CamsField10 | string | カスタムフィールド |
| CamsField11 | string | カスタムフィールド |
| CamsField12 | string | カスタムフィールド |
| CamsField13 | string | カスタムフィールド |
| CamsField14 | string | カスタムフィールド |
| CamsField15 | string | カスタムフィールド |
| CamsField16 | string | カスタムフィールド |
| CamsField17 | string | カスタムフィールド |
| CamsField18 | string | カスタムフィールド |
| CamsField19 | string | カスタムフィールド |
| CamsField20 | string | カスタムフィールド |
なし
<?xml version="1.0" encoding="UTF-8"?>
<TrackingSessionList xmlns="http://smartseminar.jp/" version="1.5">
<TrackingSession>
<Id>1</Id>
<VisitorId>1</VisitorId>
<SessionId>FcLEfUcGPedhsUfHFDK-97</SessionId>
<PageCount>6</PageCount>
<SearchEngine>google</SearchEngine>
<SearchWord>shanon</SearchWord>
<Conversion></Conversion>
<SojournTime>7分54秒</SojournTime>
<StartTime>2014-04-21T11:51:10+09:00</StartTime>
<DateUpdate>2014-04-21T11:53:10+09:00</DateUpdate>
<RemoteIp>192.168.1.1</RemoteIp>
<UserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.99 Safari/537.36</UserAgent>
<CamsField1>カスタムフィールド1</CamsField1>
<CamsField2>カスタムフィールド2</CamsField2>
<CamsField3>カスタムフィールド3</CamsField3>
<CamsField4>カスタムフィールド4</CamsField4>
<CamsField5>カスタムフィールド5</CamsField5>
<CamsField6>カスタムフィールド6</CamsField6>
<CamsField7>カスタムフィールド7</CamsField7>
<CamsField8>カスタムフィールド8</CamsField8>
<CamsField9>カスタムフィールド9</CamsField9>
<CamsField10>カスタムフィールド10</CamsField10>
<CamsField11>カスタムフィールド11</CamsField11>
<CamsField12>カスタムフィールド12</CamsField12>
<CamsField13>カスタムフィールド13</CamsField13>
<CamsField14>カスタムフィールド14</CamsField14>
<CamsField15>カスタムフィールド15</CamsField15>
<CamsField16>カスタムフィールド16</CamsField16>
<CamsField17>カスタムフィールド17</CamsField17>
<CamsField18>カスタムフィールド18</CamsField18>
<CamsField19>カスタムフィールド19</CamsField19>
<CamsField20>カスタムフィールド20</CamsField20>
</TrackingSession>
</TrackingSessionList>