jaam / mixpanel-data-export-api

用于封装 Mixpanel 数据导出 API 的工具。

v0.1.3 2018-08-16 14:10 UTC

This package is not auto-updated.

Last update: 2024-09-14 20:09:30 UTC


README

此库封装了 Mixpanel 数据导出 API 以供 PHP 使用。

要跟踪事件和更新配置文件,请参阅官方的 Mixpanel PHP 库

安装

composer require jaam/mixpanel-data-export-api

用法

Jaam\Mixpanel\DataExportApi 类包含两个公开方法 - dataexport,分别对应数据导出 API 的每个端点。

每个端点的完整文档,包括它们的参数和响应,可以在 Mixpanel 数据导出 API 文档 中找到。

设置

<?php

require_once 'vendor/autoload.php';

use Jaam\Mixpanel\DataExportApi;
use Jaam\Mixpanel\DataExportApiException;

$mixpanel = new DataExportApi('YOUR SECRET'); // Secret located in Mixpanel project settings

数据 API

有关方法、参数和响应示例,请参阅 数据导出 API 文档

// Perform setup, as above
try {
    // Retrieve events from `events` endpoint
    $data = $mixpanel->data('events', [
        'event' => ['event_name'], // Array of event names
        'type' => 'unique',
        'unit' => 'day',
        'from_date' => '2016-12-01',
        'to_date' => '2016-12-31'
    ]);

    // $data is an array
} catch ( DataExportApiException $e )
    // Handle exception
}

导出 API

有关参数和响应示例,请参阅 导出原始数据文档

// Perform setup, as above
try {
    // Export raw data
    $data = $mixpanel->export([
        'from_date' => '2016-12-01',
        'to_date' => '2016-12-31'
    ]);

    // $data is an array
} catch ( DataExportApiException $e )
    // Handle exception
}

Silex 集成

通过 Jaam\Mixpanel\Integration\Silex\MixpanelDataExportProvider 提供了与 Silex 的小型集成。

// Bootstrap Silex app

use Jaam\Mixpanel\Integration\Silex\MixpanelDataExportProvider;

$app['mixpanel.api_secret'] = 'YOUR SECRET'; // Secret located in Mixpanel project settings
$app->register(new MixpanelDataExportProvider);

// Use via `mixpanel.api` server later in application
$data = $app['mixpanel.api']->export([
    'from_date' => '2016-12-14',
    'to_date' => '2016-12-18'
]);