KAkarte
Event

Get events by user_id

ユーザーごとに記録されたイベントを取得します。

Required Scope

APIの実行に必要なScopeです。

beta.track.event.get

Required Role

管理画面でScopeを追加する際に必要な権限です。

基本機能 > 基本機能作成・編集
post/v2beta/track/event/get

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/track/event/get
  • Auth
    HTTP bearer

Headers

x-karte-apistring

今後利用する可能性のある予約語です。現在は設定不要です。

authorizationstring

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

content-typestring

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Request body

user_idstring required

特定のユーザーを識別するキー メンバーの情報を取得する場合は当該メンバーの user_id を指定します。 ビジターの情報を取得する場合は visitor_id( vis-xxxxxxxxxx の形式) をこのプロパティの引数に指定します。

event_namesstring[] required

取得したいイベントの名前をリスト形式で指定します。 最大10個のイベント名を指定することができます。

Response

A successful response.

eventsobject

リクエストで指定した event_name ごとにイベント情報が格納されます。イベントは時刻（ _date ）の昇順で格納されます。 e.g. view と buy のイベントを指定した場合、以下のような形式で返却されます。 events: { view: [ { event_hash: xxxx ... }, { event_hash: yyyy ... } ... ] buy: [ { event_hash: aaaa ... }, { event_hash: bbbb ... } ... ] } ただしリクエストで指定した user_id が存在しない場合は空のeventsが返却されます。 e.g. events: {}

Changes

No recorded changes to this operation across all 1 revision of this API.