You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We'd also love for you to come and work with us! Check out <strong><ahref="https://mixpanel.com/jobs/#openings">Jobs</a></strong> for details</p>
77
67
<h1id="quick-start-guide">Quick Start Guide</h1>
78
68
<p>Check out our <strong><ahref="https://developer.mixpanel.com/docs/flutter">official documentation</a></strong> for more in depth information on installing and using Mixpanel on Flutter.</p>
<p>To start tracking with the SDK you must first initialize with your project token. To initialize the SDK, first add <code>import 'package:mixpanel_flutter/mixpanel_flutter.dart';</code> and call <code>Mixpanel.init(token);</code> with your project token as it's argument.</p>
<p>To start tracking with the SDK you must first initialize with your project token. To initialize the SDK, first add <code>import 'package:mixpanel_flutter/mixpanel_flutter.dart';</code> and call <code>Mixpanel.init(token);</code> with your project token as it's argument. You can find your token in <ahref="https://mixpanel.com/settings/project">project settings</a>.</p>
<p>Once you've called this method once, you can access <code>mixpanel</code> throughout the rest of your application.</p>
125
-
<h3id="tracking">Tracking</h3>
126
-
<p>Once you've initialized the SDK, Mixpanel will <ahref="https://mixpanel.com/help/questions/articles/which-common-mobile-events-can-mixpanel-collect-on-my-behalf-automatically" target="_blank">automatically collect common mobile events</a>. You can enable/disable automatic collection through your <ahref="https://mixpanel.com/help/questions/articles/how-do-i-enable-common-mobile-events-if-i-have-already-implemented-mixpanel" target="_blank">project settings</a>.
127
-
With the <code>mixpanel</code> object created in <ahref="#integration">the last step</a> a call to <code>track</code> is all you need to send additional events to Mixpanel.</p>
128
-
<preclass="language-js"><codeclass="language-js">// Track with event-name
113
+
<h2id="3-send-data">3. Send Data</h2>
114
+
<p>Once you've initialized the SDK, Mixpanel will <ahref="https://mixpanel.com/help/questions/articles/which-common-mobile-events-can-mixpanel-collect-on-my-behalf-automatically" target="_blank">automatically collect common mobile events</a>. You can enable/disable automatic collection through your project settings.
115
+
With the <code>mixpanel</code> object created in <ahref="#2-initialize-mixpanel">the last step</a> a call to <code>track</code> is all you need to send additional events to Mixpanel.</p>
116
+
<preclass="language-dart"><codeclass="language-dart">// Track with event-name
<p>You're done! You've successfully integrated the Mixpanel Flutter SDK into your app. To stay up to speed on important SDK releases and updates, star or watch our repository on <ahref="https://github.com/mixpanel/mixpanel-flutter">Github</a>.</p>
134
-
<p><aname="i-want-to-know-more"></a></p>
122
+
<h2id="4-check-for-success">4. Check for Success</h2>
123
+
<p><ahref="http://mixpanel.com/report/live">Open up Live View in Mixpanel</a> to view incoming events.
124
+
Once data hits our API, it generally takes ~60 seconds for it to be processed, stored, and queryable in your project.</p>
125
+
<h1id="faq">FAQ</h1>
126
+
<p><strong>I want to stop tracking an event/event property in Mixpanel. Is that possible?</strong></p>
127
+
<p>Yes, in Lexicon, you can intercept and drop incoming events or properties. Mixpanel won’t store any new data for the event or property you select to drop. <ahref="https://help.mixpanel.com/hc/en-us/articles/360001307806#dropping-events-and-properties">See this article for more information</a>.</p>
128
+
<p><strong>I have a test user I would like to opt out of tracking. How do I do that?</strong></p>
129
+
<p>Mixpanel’s client-side tracking library contains the <ahref="https://mixpanel.github.io/mixpanel-flutter/mixpanel_flutter/Mixpanel/optOutTracking.html">optOutTracking()</a> method, which will set the user’s local opt-out state to “true” and will prevent data from being sent from a user’s device. More detailed instructions can be found in the section, <ahref="https://developer.mixpanel.com/docs/flutter#opting-users-out-of-tracking">Opting users out of tracking</a>.</p>
130
+
<p><strong>Why aren't my events showing up?</strong></p>
131
+
<p>To preserve battery life and customer bandwidth, the Mixpanel library doesn't send the events you record immediately. Instead, it sends batches to the Mixpanel servers every 60 seconds while your application is running, as well as when the application transitions to the background. You can call <ahref="https://mixpanel.github.io/mixpanel-flutter/mixpanel_flutter/Mixpanel/flush.html">flush()</a> manually if you want to force a flush at a particular moment.</p>
132
+
<preclass="language-dart"><code>mixpanel.flush();
133
+
</code></pre>
134
+
<p>If your events are still not showing up after 60 seconds, check if you have opted out of tracking. You can also enable Mixpanel debugging and logging, it allows you to see the debug output from the Mixpanel library. To enable it, call <ahref="https://mixpanel.github.io/mixpanel-flutter/mixpanel_flutter/Mixpanel/setLoggingEnabled.html">setLoggingEnabled</a> to true, then run your iOS project with Xcode or android project with Android Studio. The logs should be available in the console.</p>
<p><strong>Starting with iOS 14.5, do I need to request the user’s permission through the AppTrackingTransparency framework to use Mixpanel?</strong></p>
138
+
<p>No, Mixpanel does not use IDFA so it does not require user permission through the AppTrackingTransparency(ATT) framework.</p>
139
+
<p><strong>If I use Mixpanel, how do I answer app privacy questions for the App Store?</strong></p>
140
+
<p>Please refer to our <ahref="https://mixpanel.com/legal/app-store-privacy-details/">Apple App Developer Privacy Guidance</a></p>
135
141
<h1id="i-want-to-know-more">I want to know more!</h1>
136
142
<p>No worries, here are some links that you will find useful:</p>
<li><strong><ahref="https://developer.mixpanel.com/docs/flutter">Full API Reference</a></strong></li>
140
146
</ul>
141
147
<p>Have any questions? Reach out to Mixpanel <ahref="https://help.mixpanel.com/hc/en-us/requests/new">Support</a> to speak to someone smart, quickly.</p>
0 commit comments