@rawdash/connector-mixpanel 0.0.1 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +94 -133
- package/dist/index.d.ts +374 -3
- package/dist/index.js +168 -12
- package/dist/index.js.map +1 -1
- package/package.json +14 -13
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,119 +1,121 @@
|
|
|
1
|
+
<!-- This file is generated from connector metadata by scripts/generate-connector-docs.ts. Do not edit by hand. -->
|
|
2
|
+
|
|
1
3
|
# @rawdash/connector-mixpanel
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
[](https://www.npmjs.com/package/@rawdash/connector-mixpanel)
|
|
6
|
+
[](https://github.com/rawdash/rawdash/blob/main/LICENSE)
|
|
7
|
+
|
|
8
|
+
Sync Mixpanel active-user counts, per-event volume, funnel conversion, and cohort retention as metric time series.
|
|
9
|
+
|
|
10
|
+
> **Cost & frequency.** Each configured event and funnel costs one or more queries per sync against Mixpanel quotas; adding many events/funnels or syncing frequently can exhaust the quota.
|
|
4
11
|
|
|
5
|
-
##
|
|
12
|
+
## Install
|
|
6
13
|
|
|
7
|
-
|
|
14
|
+
```sh
|
|
15
|
+
npm install @rawdash/connector-mixpanel
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Authentication
|
|
8
19
|
|
|
9
|
-
|
|
10
|
-
2. Click **Add Service Account**.
|
|
11
|
-
3. Give it a descriptive name (e.g. `rawdash-reader`).
|
|
12
|
-
4. Choose a role of **Consumer** (read-only is sufficient for query access).
|
|
13
|
-
5. Set an expiration (a long-lived secret is fine for server use; pick a date that fits your rotation policy).
|
|
14
|
-
6. Click **Create**. Mixpanel will display the **Username** and **Secret** once; copy both before closing the dialog.
|
|
15
|
-
7. Store the secret in your secrets manager under (for example) `MIXPANEL_SECRET`. The username is not sensitive and can live in plain configuration.
|
|
16
|
-
8. Note your **Project ID** under **Settings → Project Settings → Overview**.
|
|
20
|
+
Authenticate with a Mixpanel service account (username + secret) over HTTP Basic auth, scoped to a numeric project ID.
|
|
17
21
|
|
|
18
|
-
|
|
22
|
+
1. In Mixpanel, open Project settings → Service Accounts and create a service account with at least read access to the project.
|
|
23
|
+
2. Copy the generated username (e.g. `rawdash-reader.abcdef.mp-service-account`) and the secret shown once at creation.
|
|
24
|
+
3. Find the numeric project ID under Project settings → Overview and set it as `projectId`.
|
|
25
|
+
4. Store the secret and reference it from config as `secret: secret("MIXPANEL_SECRET")`, alongside the `username`.
|
|
26
|
+
5. For EU-resident projects, set `region: "eu"`.
|
|
19
27
|
|
|
20
28
|
## Configuration
|
|
21
29
|
|
|
30
|
+
| Field | Type | Required | Description |
|
|
31
|
+
| ----------------- | ------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
32
|
+
| `username` | string | Yes | Mixpanel service account username (e.g. `rawdash-reader.abcdef.mp-service-account`). Create one at Project settings → Service Accounts. |
|
|
33
|
+
| `secret` | secret | Yes | Mixpanel service account secret, paired with the username via HTTP Basic auth. |
|
|
34
|
+
| `projectId` | string | Yes | Numeric Mixpanel project ID. Found under Project settings → Overview. |
|
|
35
|
+
| `region` | `us` \| `eu` | No | Mixpanel API region. Defaults to `us`. |
|
|
36
|
+
| `events` | array | No | Event names to fetch per-day volume and unique-user counts for. Each event runs one segmentation query per sync per type. |
|
|
37
|
+
| `funnels` | array | No | Mixpanel funnels to sync per-day conversion data for. Add one entry per funnel ID. |
|
|
38
|
+
| `retentionEvent` | string | No | Event name to use for cohort retention. When set, the connector runs a single retention query per sync. |
|
|
39
|
+
| `activeUserEvent` | string | No | Event name used for DAU/WAU/MAU unique-user counts. Defaults to the first entry in `events` when unset. |
|
|
40
|
+
| `lookbackDays` | number | No | How many days to fetch on a full sync. Defaults to 90. |
|
|
41
|
+
|
|
42
|
+
## Resources
|
|
43
|
+
|
|
44
|
+
- **`mixpanel_dau`** _(metric)_ - Daily active users - unique-user counts for the active-user event, one sample per day.
|
|
45
|
+
- Endpoint: `GET /api/2.0/segmentation (type=unique, unit=day)`
|
|
46
|
+
- Unit: users
|
|
47
|
+
- Granularity: day
|
|
48
|
+
- Dimensions: `unit`, `event`
|
|
49
|
+
- Each metric is rewritten in full per sync (idempotent replace).
|
|
50
|
+
- **`mixpanel_wau`** _(metric)_ - Weekly active users - unique-user counts for the active-user event, one sample per week.
|
|
51
|
+
- Endpoint: `GET /api/2.0/segmentation (type=unique, unit=week)`
|
|
52
|
+
- Unit: users
|
|
53
|
+
- Granularity: week
|
|
54
|
+
- Dimensions: `unit`, `event`
|
|
55
|
+
- Each metric is rewritten in full per sync (idempotent replace).
|
|
56
|
+
- **`mixpanel_mau`** _(metric)_ - Monthly active users - unique-user counts for the active-user event, one sample per month.
|
|
57
|
+
- Endpoint: `GET /api/2.0/segmentation (type=unique, unit=month)`
|
|
58
|
+
- Unit: users
|
|
59
|
+
- Granularity: month
|
|
60
|
+
- Dimensions: `unit`, `event`
|
|
61
|
+
- Each metric is rewritten in full per sync (idempotent replace).
|
|
62
|
+
- **`mixpanel_events_per_day`** _(metric)_ - Per-day volume for each configured event. The sample value is the total event count; unique-user count is carried as an attribute.
|
|
63
|
+
- Endpoint: `GET /api/2.0/segmentation (type=general and type=unique)`
|
|
64
|
+
- Unit: events
|
|
65
|
+
- Granularity: day
|
|
66
|
+
- Dimensions: `event`, `count`, `uniqueUsers`
|
|
67
|
+
- Each metric is rewritten in full per sync (idempotent replace).
|
|
68
|
+
- **`mixpanel_funnel_results`** _(metric)_ - Per-day funnel conversion. One sample per (date, step); the value is the user count reaching that step.
|
|
69
|
+
- Endpoint: `GET /api/2.0/funnels (unit=day)`
|
|
70
|
+
- Unit: users
|
|
71
|
+
- Granularity: day
|
|
72
|
+
- Dimensions: `funnelId`, `funnelName`, `step`, `stepLabel`, `users`, `conversionRate`, `stepConversionRate`
|
|
73
|
+
- Each metric is rewritten in full per sync (idempotent replace).
|
|
74
|
+
- **`mixpanel_retention`** _(metric)_ - Cohort retention for the retention event. One sample per (cohort date, period); the value is the retained user count.
|
|
75
|
+
- Endpoint: `GET /api/2.0/retention (retention_type=birth, unit=day)`
|
|
76
|
+
- Unit: users
|
|
77
|
+
- Granularity: day
|
|
78
|
+
- Dimensions: `event`, `period`, `cohortSize`, `retentionRate`
|
|
79
|
+
- Each metric is rewritten in full per sync (idempotent replace).
|
|
80
|
+
|
|
81
|
+
## Example
|
|
82
|
+
|
|
22
83
|
```ts
|
|
23
|
-
import {
|
|
84
|
+
import {
|
|
85
|
+
defineConfig,
|
|
86
|
+
defineDashboard,
|
|
87
|
+
defineMetric,
|
|
88
|
+
secret,
|
|
89
|
+
} from '@rawdash/core';
|
|
24
90
|
|
|
25
91
|
const mixpanel = {
|
|
26
92
|
name: 'mixpanel',
|
|
27
93
|
connectorId: 'mixpanel',
|
|
28
94
|
config: {
|
|
29
|
-
projectId: '1234567',
|
|
30
95
|
username: 'rawdash-reader.abcdef.mp-service-account',
|
|
31
96
|
secret: secret('MIXPANEL_SECRET'),
|
|
32
|
-
|
|
97
|
+
projectId: '1234567',
|
|
33
98
|
events: ['Signed Up', 'Purchase'],
|
|
34
|
-
funnels: [
|
|
35
|
-
{ id: 42, name: 'Activation' },
|
|
36
|
-
{ id: 99, name: 'Checkout' },
|
|
37
|
-
],
|
|
38
|
-
retentionEvent: 'Signed Up',
|
|
39
99
|
activeUserEvent: 'Signed Up',
|
|
40
|
-
|
|
100
|
+
retentionEvent: 'Signed Up',
|
|
101
|
+
funnels: [{ id: 42, name: 'Signup to Purchase' }],
|
|
41
102
|
},
|
|
42
103
|
};
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Register the connector class when mounting the engine:
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
import { MixpanelConnector } from '@rawdash/connector-mixpanel';
|
|
49
|
-
import { mountEngine } from '@rawdash/hono';
|
|
50
|
-
|
|
51
|
-
mountEngine(config, {
|
|
52
|
-
connectorRegistry: { mixpanel: MixpanelConnector },
|
|
53
|
-
});
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Then wire it into `defineConfig`:
|
|
57
|
-
|
|
58
|
-
```ts
|
|
59
|
-
import { defineConfig, defineDashboard, defineMetric } from '@rawdash/core';
|
|
60
104
|
|
|
61
105
|
export default defineConfig({
|
|
62
106
|
connectors: [mixpanel],
|
|
63
107
|
dashboards: {
|
|
64
|
-
|
|
108
|
+
growth: defineDashboard({
|
|
65
109
|
widgets: {
|
|
66
110
|
dau: {
|
|
67
|
-
kind: 'stat',
|
|
68
|
-
title: 'DAU',
|
|
69
|
-
metric: defineMetric({
|
|
70
|
-
connector: mixpanel,
|
|
71
|
-
shape: 'metric',
|
|
72
|
-
name: 'mixpanel_dau',
|
|
73
|
-
field: 'value',
|
|
74
|
-
fn: 'latest',
|
|
75
|
-
}),
|
|
76
|
-
},
|
|
77
|
-
dau_trend: {
|
|
78
111
|
kind: 'timeseries',
|
|
79
|
-
title: '
|
|
112
|
+
title: 'Daily Active Users',
|
|
80
113
|
window: '30d',
|
|
81
114
|
metric: defineMetric({
|
|
82
115
|
connector: mixpanel,
|
|
83
116
|
shape: 'metric',
|
|
84
117
|
name: 'mixpanel_dau',
|
|
85
|
-
field: 'value',
|
|
86
|
-
fn: 'sum',
|
|
87
|
-
window: '30d',
|
|
88
|
-
groupBy: { field: 'ts', granularity: 'day' },
|
|
89
|
-
}),
|
|
90
|
-
},
|
|
91
|
-
signups_per_day: {
|
|
92
|
-
kind: 'timeseries',
|
|
93
|
-
title: 'Sign-ups per day',
|
|
94
|
-
window: '30d',
|
|
95
|
-
metric: defineMetric({
|
|
96
|
-
connector: mixpanel,
|
|
97
|
-
shape: 'metric',
|
|
98
|
-
name: 'mixpanel_events_per_day',
|
|
99
|
-
field: 'count',
|
|
100
118
|
fn: 'sum',
|
|
101
|
-
window: '30d',
|
|
102
|
-
filter: [{ field: 'event', op: 'eq', value: 'Signed Up' }],
|
|
103
|
-
groupBy: { field: 'ts', granularity: 'day' },
|
|
104
|
-
}),
|
|
105
|
-
},
|
|
106
|
-
events_distribution: {
|
|
107
|
-
kind: 'distribution',
|
|
108
|
-
title: 'Top events (last 30d)',
|
|
109
|
-
metric: defineMetric({
|
|
110
|
-
connector: mixpanel,
|
|
111
|
-
shape: 'metric',
|
|
112
|
-
name: 'mixpanel_events_per_day',
|
|
113
|
-
field: 'count',
|
|
114
|
-
fn: 'sum',
|
|
115
|
-
window: '30d',
|
|
116
|
-
groupBy: { field: 'event' },
|
|
117
119
|
}),
|
|
118
120
|
},
|
|
119
121
|
},
|
|
@@ -122,61 +124,20 @@ export default defineConfig({
|
|
|
122
124
|
});
|
|
123
125
|
```
|
|
124
126
|
|
|
125
|
-
##
|
|
126
|
-
|
|
127
|
-
| Field | Required | Type | Default | Notes |
|
|
128
|
-
| ----------------- | -------- | ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
129
|
-
| `projectId` | yes | `string` (digits) | — | Mixpanel numeric project ID. |
|
|
130
|
-
| `username` | yes | `string` | — | Service-account username. |
|
|
131
|
-
| `secret` | yes | `Secret` | — | Service-account secret. Use `secret('MIXPANEL_SECRET')`. |
|
|
132
|
-
| `region` | no | `'us' \| 'eu'` | `'us'` | Switches the API host between `mixpanel.com` and `eu.mixpanel.com`. |
|
|
133
|
-
| `events` | no | `string[]` | — | Event names to fetch per-day volume + unique-user counts for. Skips the phase when empty/unset. |
|
|
134
|
-
| `funnels` | no | `{ id, name? }[]` | — | Mixpanel funnel IDs to track. Each entry produces daily funnel-step samples. Skips when empty/unset. |
|
|
135
|
-
| `retentionEvent` | no | `string` | — | Event used for the retention cohort phase. Skips when unset. |
|
|
136
|
-
| `activeUserEvent` | no | `string` | — | Event used for the DAU/WAU/MAU `unique`-type segmentation queries. Defaults to the first `events` entry. Both DAU/WAU/MAU phases skip when no event resolves. |
|
|
137
|
-
| `lookbackDays` | no | `number` | `90` | Window in days fetched on a full sync. Incremental syncs (`mode: 'latest'`) refetch the trailing 3 days regardless. |
|
|
138
|
-
|
|
139
|
-
## Data model
|
|
140
|
-
|
|
141
|
-
All resources are stored as **metric samples** (`shape: 'metric'`). The `ts` field is the bucket date in Unix milliseconds. Mixpanel returns aggregated data, so the connector writes pre-aggregated metric rows — no event-stream backfill.
|
|
142
|
-
|
|
143
|
-
| Metric name | Bucket | `value` | Attributes |
|
|
144
|
-
| ------------------------- | ------------------ | ----------------------- | ----------------------------------------------------------------------------------------------- |
|
|
145
|
-
| `mixpanel_dau` | day | unique users that day | `unit='day'`, `event` |
|
|
146
|
-
| `mixpanel_wau` | week | unique users that week | `unit='week'`, `event` |
|
|
147
|
-
| `mixpanel_mau` | month | unique users that month | `unit='month'`, `event` |
|
|
148
|
-
| `mixpanel_events_per_day` | day | total event count | `event`, `count`, `uniqueUsers` |
|
|
149
|
-
| `mixpanel_funnel_results` | day, step | users at the step | `funnelId`, `funnelName?`, `step`, `stepLabel`, `users`, `conversionRate`, `stepConversionRate` |
|
|
150
|
-
| `mixpanel_retention` | cohort day, period | retained users | `event`, `period` (days since cohort), `cohortSize`, `retentionRate` |
|
|
151
|
-
|
|
152
|
-
## Sync behaviour
|
|
153
|
-
|
|
154
|
-
- **Backfill** (`mode: 'full'`): fetches the rolling `lookbackDays` window (default 90 days) for every configured resource.
|
|
155
|
-
- **Incremental** (`mode: 'latest'`): refetches the trailing 3 days for every configured resource. Mixpanel can re-attribute late-arriving events, so a small overlap keeps the metrics accurate without re-syncing the full backfill.
|
|
156
|
-
- **Idempotency**: each phase writes via a single `storage.metrics(samples, { names: [<metric>] })` call, which replaces all prior samples for that metric. Re-running the sync against the same window converges on the same storage state.
|
|
157
|
-
- **Resumable**: the cursor captures `(phase, dateRange)` so an interrupted sync resumes at the next phase using the originally-computed window.
|
|
158
|
-
- **Resource allowlist**: `options.resources` filters which phases run. A resource not in the allowlist is skipped entirely, including its API calls.
|
|
159
|
-
- **Rate limits**: Mixpanel's Query API quota is 60 queries/hour per project (default). The connector batches each event/funnel into one query and reuses the result across active-user phases where possible. 429 responses fall through to the shared HTTP client's retry-with-backoff path.
|
|
160
|
-
|
|
161
|
-
## Schemas
|
|
127
|
+
## Rate limits
|
|
162
128
|
|
|
163
|
-
|
|
129
|
+
Mixpanel's Query API quota is 60 queries/hour per project (default); requests are retried with backoff.
|
|
164
130
|
|
|
165
|
-
|
|
166
|
-
| --------------------- | ----------------------------------------------------------------------------------- |
|
|
167
|
-
| `dau` / `wau` / `mau` | `GET /api/2.0/segmentation?type=unique&unit={day,week,month}` per active-user event |
|
|
168
|
-
| `events_per_day` | `GET /api/2.0/segmentation?type={general,unique}&unit=day` per configured event |
|
|
169
|
-
| `funnel_results` | `GET /api/2.0/funnels?funnel_id=…&unit=day` per configured funnel |
|
|
170
|
-
| `retention` | `GET /api/2.0/retention?retention_type=birth&unit=day&born_event=…&event=…` |
|
|
131
|
+
## Limitations
|
|
171
132
|
|
|
172
|
-
|
|
133
|
+
- Incremental syncs refetch a 3-day overlap because Mixpanel can re-attribute late-arriving events.
|
|
173
134
|
|
|
174
|
-
|
|
135
|
+
## Links
|
|
175
136
|
|
|
176
|
-
|
|
137
|
+
- [Rawdash docs](https://rawdash.dev/docs/connectors/)
|
|
138
|
+
- [Mixpanel API docs](https://developer.mixpanel.com/reference/query-api)
|
|
139
|
+
- [GitHub](https://github.com/rawdash/rawdash)
|
|
177
140
|
|
|
178
|
-
|
|
141
|
+
## License
|
|
179
142
|
|
|
180
|
-
|
|
181
|
-
2. Pipe them through `connector.sync()` against an `InMemoryStorage` instance.
|
|
182
|
-
3. Assert universal invariants (finite timestamps, no `undefined` leaking, no thrown errors) plus per-resource cardinality (one sample per unique date, one funnel sample per `(date, step)`, one retention sample per `(cohort, period)`).
|
|
143
|
+
Apache-2.0
|