資料ダウンロード履歴情報取得API

マーケティングプラットフォームのキャンペーンに関連する申込情報を参照するためのAPIです。

メソッド名

visitor.getDocumentdownload

リクエスト情報

アクセスURL

メソッド	URL
GET	https://{domainname}/services/rest/visitor/documentdownload

URL部パラメータ

パラメータ名	必須	内容
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
DocumentId	○	○	資料ID
DownloadDate	○	○	ダウンロード日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：DocumentDownload ★ データ型：DocumentDownloadType

カラム名	データ型	内容
Id	string	資料ダウンロード履歴ID
DocumentId	string	資料ID
VisitorId	string	リードID
DownloadDate	dateTime	ダウンロード日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<DocumentDownloadList xmlns="http://smartseminar.jp" version="1.1">
　<DocumentDownload>
　　<Id>1</Id>
　　<DocumentId>2</DocumentId>
　　<VisitorId>3</VisitorId>
　　<DocumentDownloadDate>2009-08-31T20:08:07</DocumentDownloadDate>
　</DocumentDownload>
</DocumentDownloadList>

制限事項

なし