Amplify JS API Documentation
    Preparing search index...

    Function configureAutoTrack

    • Parameters

      Returns void

    • Configures automatic event tracking for Kinesis. This API will automatically transmit an analytic event to the configured Kinesis stream when configured events are detected within your application. This can include: DOM element events (via the event tracker), session events (via the session tracker), and page view events (via the pageView tracker).

      Auto-tracked events are recorded with a data payload of the shape { name: eventName, attributes }.

      Parameters

      Returns void

      Only session tracking is currently supported on React Native.

      validation: AnalyticsValidationErrorCode - Thrown when the provided parameters or library configuration is incorrect, or when streamName / partitionKey are missing while enabling a tracker.

      // Enable session tracking
      configureAutoTrack({
          enable: true,
          type: 'session',
          options: {
              streamName: 'myKinesisStream',
              partitionKey: 'myPartitionKey',
          },
      });

      // Enable page view tracking for a single-page application
      configureAutoTrack({
          enable: true,
          type: 'pageView',
          options: {
              streamName: 'myKinesisStream',
              partitionKey: 'myPartitionKey',
              appType: 'singlePage',
          },
      });

      // Enable DOM element event tracking
      configureAutoTrack({
          enable: true,
          type: 'event',
          options: {
              streamName: 'myKinesisStream',
              partitionKey: 'myPartitionKey',
          },
      });

    Settings

    Member Visibility