Mixpanel-node 技术文档

1. 安装指南

要使用 mixpanel-node，首先需要通过 npm 进行安装：

npm install mixpanel

2. 项目使用说明

mixpanel-node 是一个服务器端 JavaScript 库，为 Mixpanel 提供了许多官方 JavaScript 库的功能。它是易于使用的，完全异步，并旨在在服务器上使用（它不是一个客户端模块）。浏览器客户端库可在 mixpanel-js 获得。

以下是 mixpanel-node 的基本用法：

var Mixpanel = require('mixpanel');
var mixpanel = Mixpanel.init('<YOUR_TOKEN>');

使用 <YOUR_TOKEN> 替换为您的 Mixpanel 项目令牌。

跟踪事件

mixpanel.track('my event', {
    distinct_id: 'some unique client id',
    properties: 'as',
    you: 'want'
});

设置用户属性

mixpanel.people.set('billybob', {
    $first_name: 'Billy',
    $last_name: 'Bob',
    $created: (new Date('jan 1 2013')).toISOString(),
    plan: 'premium',
    games_played: 1,
    points: 0
});

3. 项目API使用文档

mixpanel-node 提供了丰富的 API 用于跟踪事件、设置用户属性等。

跟踪事件

mixpanel.track(event, [properties], [callback]) - 跟踪一个事件。

设置用户属性

mixpanel.people.set(distinct_id, properties, [options]) - 设置或更新一个用户的属性。

创建或更新用户

mixpanel.people.set_once(distinct_id, properties) - 仅当属性不存在时设置用户属性。

增加用户属性值

mixpanel.people.increment(distinct_id, properties) - 增加用户的数值属性。

添加到列表

mixpanel.people.append(distinct_id, properties) - 将值追加到列表。

合并到列表

mixpanel.people.union(distinct_id, properties) - 合并值到列表中，忽略重复项。

跟踪交易

mixpanel.people.track_charge(distinct_id, amount) - 记录一个用户的交易。

清除交易历史

mixpanel.people.clear_charges(distinct_id) - 清除用户的交易历史。

删除用户

mixpanel.people.delete_user(distinct_id) - 删除一个用户。

更多 API 使用详情，请参考官方文档。

4. 项目安装方式

如前所述，项目的安装方式是通过 npm：

npm install mixpanel

安装后，你可以通过 require('mixpanel') 在你的项目中引入 mixpanel-node 库。