クリックカウントURL情報取得API

マーケティングプラットフォームのクリックカウントURL情報を参照するためのAPIです。

メソッド名

clickcounturl.get

リクエスト情報

アクセスURL

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

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	○	○	クリックカウントURL ID
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
MailReservedId	○	○	メール予約配信ID
Memo	○	○	メモ
UrlName	○	○	クリックカウントURL名
TargetUrl	○	○	ターゲットURL

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：ClickCountUrl ★ データ型：ClickCountUrlType

カラム名	データ型	内容
Id	string	クリックカウントURL ID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
Url	string	クリックカウントURL
TargetUrl	string	ターゲットURL
UrlName	string	URL名
MailReservedId	string	メール予約ID
NumberOfMailSending	nonNegativeInteger	メール送信数
NumberOfTotalClick	nonNegativeInteger	総クリック数
NumberOfTotalClickForUser	nonNegativeInteger	純クリック数
RateOfTotalClick	nonNegativeInteger	総クリック率
RateOfTotalClickForUser	nonNegativeInteger	純クリック率
Memo	string	メモ

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<ClickCountUrlList xmlns="http://smartseminar.jp" version="1.1">
　<ClickCountUrl>
　　<Id>1</Id>
　　<Url>https://192.168.1.172/cc/?c_d=1bZz5KF5ahYKX-378</Url>
　　<TargetUrl>http://www.shanon.co.jp/4</TargetUrl>
　　<UrlName>http://www.shanon.co.jp/4</UrlName>
　　<MailReservedId>3</MailReservedId>
　　<NumberOfMailSending>6</NumberOfMailSending>
　　<NumberOfTotalClick>2</NumberOfTotalClick>
　　<NumberOfTotalClickForUser>1</NumberOfTotalClickForUser>
　　<RateOfTotalClick>0.333</RateOfTotalClick>
　　<RateOfTotalClickForUser>0.167</RateOfTotalClickForUser>
　　<Memo>テストクリックカウントです。</Memo>
　</ClickCountUrl>
</ClickCountUrlList>

制限事項

なし