@capacitor-community/appcenter-analytics
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published


    App Center Analytics

    @capacitor-community/appcenter-analytics

    App Center Analytics helps you understand user behavior and customer engagement to improve your app. The SDK automatically captures session count and device properties like model, OS version, etc. You can define your own custom events to measure things that matter to you. All the information captured is available in the App Center portal for you to analyze the data.


    Maintainers

    Maintainer GitHub Social
    John Borges johnborges @johnborges

    Install

    npm install @capacitor-community/appcenter-analytics
    npx cap sync

    Session and Device Info

    Once you add App Center Analytics to your app and the SDK is started, it will automatically track sessions and device properties like OS Version, model, etc. You don’t need to write any additional code.

    Usage

    API

    setEnabled(...)

    setEnabled(options: { enable: boolean; }) => Promise<void>

    You can enable and disable App Center Analytics at runtime. If you disable it, the SDK won't collect any more analytics information for the app.

    Param Type
    options { enable: boolean; }

    Since: 0.3.0


    isEnabled()

    isEnabled() => Promise<{ value: boolean; }>

    Check if Analytics is enabled or not.

    Returns: Promise<{ value: boolean; }>

    Since: 0.0.1


    pause()

    pause() => Promise<void>

    Pause transmission of Analytics logs. While paused, Analytics logs are saved to disk.

    Since: 0.1.0


    resume()

    resume() => Promise<void>

    Resume transmission of Analytics logs. Any Analytics logs that accumulated on disk while paused are sent to the server.

    Since: 0.1.0


    trackEvent(...)

    trackEvent(options: AnalyticsEvent) => Promise<void>

    Track an event with optional custom properties to know what's happening in your app, understand user actions, and see the aggregates in the App Center portal.

    Param Type
    options AnalyticsEvent

    Since: 0.1.0


    enableManualSessionTracker()

    enableManualSessionTracker() => Promise<void>

    Enable manual session tracker. Call this method before Analytics starts.

    Since: 2.0.0


    startSession()

    startSession() => Promise<void>

    Start a new session if manual session tracker is enabled, otherwise do nothing.

    Since: 2.0.0


    Interfaces

    AnalyticsEvent

    Prop Type Description
    name string 256 character limit
    properties { [key: string]: string; } Only 20 properties allowed per event
    flag 'normal' | 'critical'

    Install

    npm i @capacitor-community/appcenter-analytics

    DownloadsWeekly Downloads

    328

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    41 kB

    Total Files

    28

    Last publish

    Collaborators

    • tafelnl
    • thegnuu
    • pbowyer
    • capcombot
    • jcesarmobile
    • maxlynch
    • mhartington
    • dotnetkow
    • it_mike_s
    • byrds
    • rdlabo
    • priyankpatel
    • dwieeb
    • stewan
    • arielhernandezmusa
    • jeepq
    • start9keagan
    • boosten
    • nklayman
    • ihadeed
    • danielprr
    • ckgaparajita
    • jpender
    • nhyatt
    • pwespi
    • epicshaggy
    • thomasvidas
    • robingenz
    • diachedelic
    • johnborges
    • tobyas
    • elylucas
    • larsmikkelsen
    • giodimiliaionic
    • brownoxford
    • mrbatista
    • bazuka5801
    • hemang