Edit in GitHubLog an issue

Analytics API reference

clearQueue

Force delete, without sending to Analytics, all hits being stored or batched on the SDK.

Java

Syntax

Copied to your clipboard
public static void clearQueue()

Example

Copied to your clipboard
Analytics.clearQueue();

Kotlin

Example

Copied to your clipboard
Analytics.clearQueue();

extensionVersion

The extensionVersion() API returns the version of the Analytics extension that is registered with the Mobile Core extension.

To get the version of the Analytics extension, use the following code sample:

Java

Syntax

Copied to your clipboard
public static String extensionVersion()

Example

Copied to your clipboard
String analyticsExtensionVersion = Analytics.extensionVersion();

Kotlin

Example

Copied to your clipboard
val extensionVersion = Analytics.extensionVersion();

getQueueSize

Retrieves the total number of Analytics hits in the tracking queue.

Java

Syntax

Copied to your clipboard
public static void getQueueSize(@NonNull final AdobeCallback<Long> callback)

Example

Copied to your clipboard
Analytics.getQueueSize(new AdobeCallbackWithError<Long>() {
    @Override
    public void fail(AdobeError adobeError) {
        // Handle the error
    }


    @Override
    public void call(Long size) {
        // Handle the queue size
    }
});

Kotlin

Example

Copied to your clipboard
Analytics.getQueueSize(object: AdobeCallbackWithError<Long> {
    override fun call(size: Long?) {
        // Handle the queue size
    }


    override fun fail(error: AdobeError?) {
        // Handle the error
    }
})

getQueueSizeWithCompletionHandler

Retrieves the total number of Analytics hits in the tracking queue. Invoke the callback with NSError if an unexpected error occurs or the request times out.

Swift

Syntax

Copied to your clipboard
static func getQueueSize(completion: @escaping (Int, Error?) -> Void)

Example

Copied to your clipboard
Analytics.getQueueSize { (queueSize, error) in
    // Handle error (if non-nil) or use queueSize.
}

Objective-C

Syntax

Copied to your clipboard
+ (void)getQueueSize:^(NSInteger, NSError * _Nullable)completion

Example

Copied to your clipboard
[AEPMobileAnalytics getQueueSize:^(NSInteger queueSize, NSError * _Nullable error) {
    // Handle error (if non-nil) or use queueSize.
 }];

getTrackingIdentifier

Retrieves the Analytics tracking identifier that is generated for this app/device instance. This identifier is an app-specific, unique visitor ID that is generated at the initial launch and is stored and used after the initial launch. The ID is preserved between app upgrades and is removed when the app is uninstalled as well as on MobileCore.resetIdentities API call or on privacy status opt out.

Java

Syntax

Copied to your clipboard
public static void getTrackingIdentifier(@NonNull final AdobeCallback<String> callback)
  • callback is invoked with the tracking Identifier string value. When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with analytics tracking identifier.

Example

Copied to your clipboard
Analytics.getTrackingIdentifier(new AdobeCallbackWithError<String>() {
    @Override
    public void fail(AdobeError adobeError) {
        // Handle the error
    }


    @Override
    public void call(String s) {
        // Handle the Experience Cloud ID
    }
});

Kotlin

Example

Copied to your clipboard
Analytics.getTrackingIdentifier(object: AdobeCallbackWithError<String> {
    override fun call(id: String?) {
        // Handle the Experience Cloud ID
    }


    override fun fail(error: AdobeError?) {
        // Handle the error
    }
})

getTrackingIdentifierWithCompletionHandler

Retrieves the Analytics tracking identifier that is generated for this app/device instance. This identifier is an app-specific, unique visitor ID that is generated at the initial launch and is stored and used after the initial launch. The ID is preserved between app upgrades and is removed when the app is uninstalled. Invoke the callback with NSError if an unexpected error occurs or the request times out.

Swift

Syntax

Copied to your clipboard
static func getTrackingIdentifier(completion: @escaping (String?, Error?) -> Void)

Example

Copied to your clipboard
Analytics.getTrackingIdentifier { (trackingId, error) in
   // Handle the error (if non-nil) or use the trackingIdentifier value
}

Objective-C

Syntax

Copied to your clipboard
+ (void) getTrackingIdentifier:^(NSString * _Nullable, NSError * _Nullable)completion

Example

Copied to your clipboard
AEPMobileAnalytics getTrackingIdentifier:^(NSString * _Nullable trackingIdentifier, NSError * _Nullable error) {
   // Handle the error (if non-nil) or use the trackingIdentifier value
}];

getVisitorIdentifier

This API gets a custom Analytics visitor identifier, which has been set previously using setVisitorIdentifier.

Java

Syntax

Copied to your clipboard
public static void getVisitorIdentifier(@NonNull final AdobeCallback<String> callback)
  • callback is invoked with the visitor identifier value. When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with visitor identifier.

Example

Copied to your clipboard
Analytics.getVisitorIdentifier(new AdobeCallbackWithError<String>() {
    @Override
    public void fail(AdobeError adobeError) {
        // Handle the error
    }


    @Override
    public void call(String s) {
        // Handle the Visitor ID
    }
});

Kotlin

Example

Copied to your clipboard
Analytics.getVisitorIdentifier(object: AdobeCallbackWithError<String> {
    override fun call(id: String?) {
        // Handle the Visitor ID
    }


    override fun fail(error: AdobeError?) {
        // Handle the error
    }
})

getVisitorIdentifierWithCompletionHandler

This API gets a custom Analytics visitor identifier, which has been set previously using setVisitorIdentifier. Callback with NSError if an unexpected error occurs or the request times out.

Swift

Syntax

Copied to your clipboard
static func getVisitorIdentifier(completion: @escaping (String?, Error?) -> Void)

Example

Copied to your clipboard
Analytics.getVisitorIdentifier { (visitorIdentifier, error) in
   // Handle the error (if non-nil) or use the visitorIdentifier value
}

Objective-C

Syntax

Copied to your clipboard
+ (void) getVisitorIdentifier:^(NSString * _Nullable, NSError * _Nullable)completion

Example

Copied to your clipboard
[AEPMobileAnalytics getVisitorIdentifier:^(NSString * _Nullable visitorIdentifier, NSError * _Nullable error) {
   // Handle the error (if non-nil) or use the visitorIdentifier value
}];

registerExtension

Registers the Analytics extension with the Mobile Core SDK.

Java

Syntax

Copied to your clipboard
public static void registerExtension()

Example

Copied to your clipboard
Analytics.registerExtension();

Kotlin

Example

Copied to your clipboard
Analytics.registerExtension()

resetIdentities

Clears the identities stored in the Analytics extension - tracking identifier (AID) and the custom visitor identifiers (VID) stored in the Analytics extension and force deletes, without sending to Analytics, all hits being stored or batched on the SDK.

sendQueuedHits

Sends all queued hits to Analytics, regardless of the current hit batch settings.

This method forces the library to send all hits in the offline queue, regardless of how many hits are currently queued.

Java

Syntax

Copied to your clipboard
public static void sendQueuedHits()

Example

Copied to your clipboard
Analytics.sendQueuedHits();

Kotlin

Example

Copied to your clipboard
Analytics.sendQueuedHits();

setVisitorIdentifier

Sets a custom Analytics visitor identifier. For more information, see Custom Visitor ID.

Java

Syntax

Copied to your clipboard
public static void setVisitorIdentifier(@NonNull final String visitorID)
  • visitorIdentifier is the new value for the visitor identifier.

Example

Copied to your clipboard
Analytics.setVisitorIdentifier("custom_identifier");

Kotlin

Example

Copied to your clipboard
Analytics.setVisitorIdentifier("custom_identifier");
Praveen
Last updated 4/5/2024
Was this helpful?

Community

Support

Adobe Developer

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.