---
title: "Get user statistics."
method: POST
path: "/v2beta/track/user/get"
tags: ["User"]
---

# Get user statistics.

`POST /v2beta/track/user/get`

## Request

- Base URL: `https://api.karte.io`
- URL: `https://api.karte.io/v2beta/track/user/get`
- Auth: HTTP bearer

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

#### Required Scope
APIの実行に必要なScopeです。
```
beta.track.user.get
```

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
基本機能 > 基本機能作成・編集
```

## Headers

- `x-karte-api` string
- `authorization` string
- `content-type` string

## Request body

- object
  - `user_id` string, required: 特定のユーザーを識別するキー。 メンバーの情報を取得する場合は当該メンバーの user_id を指定します。 ビジターの情報を取得する場合は visitor_id( `vis-xxxxxxxxxx` の形式) をこのプロパティの引数に指定します。
  - `options` object, nullable
    - `segments` boolean: セグメント情報の要否。true を指定した場合はセグメント情報を返却します。

## Response `200`

A successful response.

- object
  - `user_id` string
  - `last_update_time` string
  - `segments` string[], nullable: ユーザーが入っているセグメントのIDを配列で返却します。 リクエストの `options` で `segments = true` を設定した場合のみ値を返却します。
  - `shorten_segments` string[], nullable: ユーザーが入っているセグメントの短縮IDを配列で返却します。 リクエストの `options` で `segments = true` を設定した場合のみ値を返却します。
  - `dimensions` object: ユーザーのディメンションの値をkey-value形式で返却します。 keyはディメンションのレポート用キーもしくはレポート用IDです。 valueはkeyに対応するディメンションの値です。

---

[API](https://skmtc.dev/karte/apis/insight.md) - [All operations](https://skmtc.dev/karte/apis/insight/llms.txt) - [OpenAPI document](https://skmtc.dev/karte/apis/insight/revisions/0081a93c4d1d?raw)