Track

ユーザーの各操作をイベントとして記録するAPIです。イベントを記録することで、ユーザーの行動を基準とした分析がFlip上で行えるようになります。

POST https://app.flip.inc/v1/track

{
  "ingestionKey": "プロジェクトの収集キー", // プロジェクトの設定画面に表示されている値に変更して下さい
  "name": "signed_up",
  "originalUserId": "usr_GXfryD0JQivyGa97TgGsT",
  "properties": {
    "sign_up_method": "google"
  },
  "userProperties": {
    "name": "Yamanaka Kaori",
    "email": "[email protected]",
    "position": "エンジニア",
    "purpose_of_use": "既存の業務を効率化したい"
  }
}

名前	必須	データ型	説明
`ingestionKey`	✔︎	`String`	データの送信先であるプロジェクトを識別するための認証キー。プロジェクトの設定画面から値を確認できる。
`name`	✔︎	`String`	ユーザーが実施したイベントの名前。アルファベットとアンダースコア（_）のみ使用可能。
`originalUserId`		`String`	このイベントを実行したユーザーのID。`anonymousId`が指定されていない場合は必須。
`anonymousId`		`String`	このイベントを実行した匿名ユーザーのID。`originalUserId`が指定されていない場合は必須。
`properties`		`Object`	このイベントの分析軸を増やすために追加できる情報。オブジェクトのキーには、アルファベットとアンダースコア（_）のみ使用可能。
`userProperties`		`Object`	このイベントを実行したユーザーの属性情報。オブジェクトのキーには、アルファベットとアンダースコア（_）のみ使用可能。

Identify

ユーザー情報の追加/変更ができるAPIです。ユーザー情報を追加することで、分析時に追加できる分析軸やフィルターが増える他、可視化時にユーザー情報を確認できるようになります。

POST https://app.flip.inc/v1/identify

{
  "ingestionKey": "プロジェクトの収集キー", // プロジェクトの設定画面に表示されている値を入力して下さい
  "originalUserId": "usr_GXfryD0JQivyGa97TgGsT",
  "properties": {
    "name": "Yamanaka Kaori",
    "email": "[email protected]",
    "position": "エンジニア",
    "purpose_of_use": "既存の業務を効率化したい"
  }
}

名前	必須	データ型	説明
`ingestionKey`	✔︎	`String`	データの送信先であるプロジェクトを識別するための認証キー。プロジェクトの設定画面から値を確認できる。
`originalUserId`		`String`	ユーザーのID。`anonymousId`が指定されていない場合は必須。
`anonymousId`		`String`	匿名ユーザーのID。`originalUserId`が指定されていない場合は必須。
`properties`		`Object`	分析軸を増やすために追加できるユーザーの属性情報。オブジェクトのキーには、アルファベットとアンダースコア（_）のみ使用可能。