来場数集計情報取得API

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

メソッド名

counting.getAttendance

リクエスト情報

アクセスURL

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

URL部パラメータ

パラメータ名	必須	内容
search_key{cid}	オプション	検索条件のキー項目指定可能なキー項目は下記「検索条件に指定可能なカラム」参照
search_operator{cid}	オプション	“検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like”
search_value{cid}	オプション	検索値 Nullを指定する場合は、何も指定しません。例： search_value1=
point_of_view	必須	集計対象を指定する「Seminar」（キャンペーン）または「Session」（サブキャンペーン）キャンペーン内の総リード数を取得する場合はSmeinarを、サブキャンペーン単位の場合はSessionを指定してください。

検索条件・並び順に指定可能なカラム

カラム名	検索条件	並び順	内容
Seminar.Id	○	○	キャンペーンID
Session.Id	○	○	サブキャンペーンID

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★エレメント名：CountingAttendance ★データ型：CountingType

カラム名	データ型	内容
PointOfView	PointOfViewType	キャンペーンID（またはサブキャンペーンID） PointOfViewId ※PointOfViewId の内容は、PointOfViewTypeId の値によって変わります。 PointOfViewTypeId=1 の場合：キャンペーン ID PointOfViewTypeId=2 の場合：サブキャンペーン ID
PointOfViewType	PointOfViewTypeType	キャンペーンタイプ PointOfViewTypeId：PointOfViewTypeName 1：Seminar 2：Session
NumberOfAttendees	nonNegativeInteger	来場数

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<CountingAttendanceList xmlns="http://smartseminar.jp/" version="1.21">
　<CountingAttendance>
　　<PointOfView>
　　　<PointOfViewId>2</PointOfViewId>
　　</PointOfView>
　　<NumberOfAttendees>0</NumberOfAttendees>
　　<PointOfViewType>
　　　<PointOfViewTypeName>Session</PointOfViewTypeName>
　　　<PointOfViewTypeId>1</PointOfViewTypeId>
　　</PointOfViewType>
　</CountingAttendance>
　<CountingAttendance>
　　<PointOfView>
　　　<PointOfViewId>3</PointOfViewId>
　　</PointOfView>
　　<NumberOfAttendees>0</NumberOfAttendees>
　　<PointOfViewType>
　　　<PointOfViewTypeName>Session</PointOfViewTypeName>
　　　<PointOfViewTypeId>1</PointOfViewTypeId>
　　</PointOfViewType>
　</CountingAttendance>
　<CountingAttendance>
　　<PointOfView>
　　　<PointOfViewId>4</PointOfViewId>
　　</PointOfView>
　　<NumberOfAttendees>0</NumberOfAttendees>
　　<PointOfViewType>
　　　<PointOfViewTypeName>Session</PointOfViewTypeName>
　　　<PointOfViewTypeId>2</PointOfViewTypeId>
　　</PointOfViewType>
　</CountingAttendance>
</CountingAttendanceList>

制限事項

なし