---
title: "Send event to KARTE"
method: POST
path: "/v2/track/event/write"
tags: ["Event"]
---

# Send event to KARTE

`POST /v2/track/event/write`

## Request

- Base URL: `https://api.karte.io`
- URL: `https://api.karte.io/v2/track/event/write`
- Auth: HTTP bearer

イベントを API 経由で KARTE に送信し、ユーザーの解析に利用できます。 API 経由のイベントは、ポップアップやメール、アプリプッシュ通知などの全てのアクションの配信トリガーとして利用できません。イベントの書き込みは非同期で実行されます。

イベント送信の際の制限は以下のページを参照してください。

[KARTEの様々な上限 / 制限について | スタートガイド / KARTE基礎知識・仕様 / KARTE動作環境 | KARTEサポートサイト](https://support.karte.io/post/7leyGX8ReFdgukJBUtCWJP#1-0)

[イベントで使用できないイベント名、フィールド名、フィールド値 | スタートガイド / タグ設置・イベント計測 / 概要 | KARTEサポートサイト](https://support.karte.io/post/44VkfBjO7JdRnDv9YOfbFB)

#### Required Scope
APIの実行に必要なScopeです。
```
track.event.write
```

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

## Headers

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

## Request body

- object
  - `keys` Keys, required: 送信データのキーとなるデータ。keys には user_id か visitor_id のどちらかが必須となります。両方指定することはできません。
    - `user_id` string: KARTE で解析されたユーザーのキー (identify イベントで送信される user_id フィールドの値)。 なお、合致する user_id を持つユーザーが存在しない場合、新しくユーザーが作成されます。
    - `visitor_id` string: ユーザーを識別する任意のキー
  - `event` Event, required: 送信するイベントの情報
    - `event_name` string, required: KARTE でイベントとして識別される文字列 ** 利用いただけない event_name ** - page - req - enter_group - leave_group - view - group - message_send - date - message_open - message_click - message_clicked - message_close
    - `values` object: 任意のKey-Value型の値 * identify イベントを送信する場合、ユーザーデータ管理機能をご利用いただくために values 内に user_id を含めていただく必要があります。詳細については、[こちら](https://support.karte.io/post/5WaAqgOMKu7ghwI9ChBVw3#2-2)をご参照ください。 * Key-ValueのValueには任意の型（string, bool, number, object, array）が指定できます。APIリファレンス上でフィールドを追加すると自動的にstring型になってしまうため、string以外の型を指定する場合はお手元の環境でご確認ください。

## Response `200`

success

- object
  - `id` string, required: requestを一意に識別するID

## Other responses

- `422`: APIのイベント送信数の上限に達した場合

---

[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)