KAkarte
User

Get user statistics.

ユーザーの統計情報を取得できます。

  • 取得できる統計情報は、ディメンション機能で設定しているユーザー情報変数の統計値とセグメント情報です。

Required Scope

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

beta.track.user.get

Required Role

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

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

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/track/user/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 の形式) をこのプロパティの引数に指定します。

Response

A successful response.

user_idstring
last_update_timestring
segmentsstring[] nullable

ユーザーが入っているセグメントのIDを配列で返却します。 リクエストの options で segments = true を設定した場合のみ値を返却します。

shorten_segmentsstring[] nullable

ユーザーが入っているセグメントの短縮IDを配列で返却します。 リクエストの options で segments = true を設定した場合のみ値を返却します。

dimensionsobject

ユーザーのディメンションの値をkey-value形式で返却します。 keyはディメンションのレポート用キーもしくはレポート用IDです。 valueはkeyに対応するディメンションの値です。

Changes

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