マーケティングプラットフォームの活動履歴情報を参照するためのAPIです。
visitor.getActivity
メソッド | URL |
---|---|
GET | https://{domainname}/services/rest/visitor/activity |
パラメータ名 | 必須 | 内容 |
---|---|---|
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 |
ActivityDate | ○ | ○ | 活動日付(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
DateRegist | ○ | ○ | 登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
DateUpdate | ○ | ○ | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
Attribute{aid} | ○ | × | 追加項目 追加項目について/追加項目のデータ型参照 |
なし
なし
コード | 内容 |
---|---|
200 | 正常終了 |
なし
★ エレメント名:Activity ★ データ型:ActivityType
カラム名 | データ型 | 内容 |
---|---|---|
Id | string | 活動履歴ID |
VisitorId | string | リードID |
ActivityDate | dateTime | 活動日付 YYYY-mm-ddTHH:MM:SS+09:00 |
Attribute{aid} | - | 追加項目 追加項目について/追加項目のデータ型参照 |
なし
<?xml version='1.0' encoding='UTF-8'?>
<ActivityList xmlns="http://smartseminar.jp" version="1.1">
<Activity><!--activity_history_id-->
<Id>2</Id>
<VisitorId>10</VisitorId>
<ActivityDate>2099-08-31T11:33:20</ActivityDate>
<Attribute1>活動内容</Attribute1>
<Attribute2List>
<Attribute2>
<Attribute2Id>1</Attribute2Id>
<Attribute2Name>メール</Attribute2Name>
</Attribute2>
</Attribute2List>
</Activity>
</ActivityList>
なし