DPI Integration FAQ

• Android Mobile

• Android Tablets

• Android Smart TV’s

• Android Native

• Jetpack Compose

• Get Client ID:

ConvivaAppAnalytics.getClientId(context);

• Set Client ID:

ConvivaAppAnalytics.setClientId(context, "client-id");

Use the trackCustomEvent() API to track all kinds of events. This API provides 2 fields to describe the tracked events:

// eventName - Name of the custom event
// eventData - Data in a JSONObject or a JSON-formatted String
// Set up the event properties JSONObject
JSONObject eventDataJSON = new JSONObject();
eventDataJSON.put("identifier1", intValue);
eventDataJSON.put("identifier2", boolValue);
eventDataJSON.put("identifier3", "stringValue");

String eventName = "your-event-name";

tracker.trackCustomEvent(eventName, eventDataJSON);

Why are some events that are supposed to be auto-collected not reported?

Add the following proguard rules to keep Conviva SDK classes from obfuscation.

-keepnames class * extends android.view.View
-keep, allowshrinking class com.conviva.** { *; }

If multidex is enabled and a multidex-config.pro is being used by the application, please add the following rule to the config.pro – CadActive file.
-keep class com.conviva. { *; }

Exclude any classes that you do not want Conviva to track.

// For Android Gradle Plugin version <7.0
// in the app build.gradle
...
android {
...
conviva {
excludePackages = ["com/example/.",
"org/example/."]
}
...
}
// For Android Gradle Plugin version >=7.2
// in the app build.gradle
...
android {
...
conviva {
excludePackages = ["com/example/",
"org/example/"]
}
...
}

/ctp

.m3u8

.m4

We support only the

• OKHTTP3 execute/enqueue

• OKHTTP3 retrofit execute/enqueue

• HTTPURLConnection/HTTPSURLConnection

Response and Request Body atributes are collected only when the:

• size is < 10kb and the content-length is available

• content-type is "json" or "text/plain"

• data is a JSONObject or Nested JSONObject or JSONArray

Response and Request Headers are collected only when the:

• data is a JSONObject, Nested JSONObject and JSONArray

• server is provisioned with "Access-Control-Expose-Headers:"*

We support:

• Activities

• Android Fragments

• Jetpack Compose

App or Screen Load times

We support only:

• Activities

Doesn’t support the:

• Android Fragments

• Jetpack Compose

As the screen load times are not reliable and are inaccurate for Fragments/Compose, we will not be able to collect it in future as well.

User Click Tracking

We support any clickable element clicking for:

• Android Native

• Jetpack Compose

Traceparent Header Generation

App Crashes

We support collecting:

• Any crash after conviva is initialised

• Will be trying to send the crash details before the application exits due to crash

We don't support:

• Any crash before conviva is initialised

Conviva Android SDK listens to the unhandled exceptions leading to app crashes and attempts sending the crash events before app exits. If an app crash event is not sent before the app exists, SDK attempts to send that crash event only after the next app launch, which will be discarded if sent after 90 seconds of original crash timestamp.

• Apple iPhones (iOS)

• Apple TV (tvOS)

• Apple Native

• Swift UI

• Get Client ID:

//Swift:
let clientId = CATAppAnalytics.sharedInstance()?.getClientId();

//ObjC:
NSString *clid = [[CATAppAnalytics sharedInstance] getClientId];

• Set Client ID:

//Swift:
CATAppAnalytics.sharedInstance()?.setClientId(clientId);

//ObjC:
[[CATAppAnalytics sharedInstance] setClientId:clid];

Use the two APIs to track custom events:

/**
* Track custom event.
* @param name Name of the custom event.
* @param data A JSON-formatted string.
 */
- (void)trackCustomEvent:(NSString *)name data:(nonnull NSString*)data;

/**
* Track custom event.
* @param name Name of the custom event.
* @param eventData Dictionary/Array of dictionaries.
 */
- (void)trackCustomEvent:(NSString *)name eventData:(nonnull id)eventData;

Examples:

// Swift:
var eventData = ["identifier1":"test","identifier2":1,"identifier3":true] as [String : Any]
tracker?.trackCustomEvent("your-event-name", eventData: eventData)

// ObjC:
NSDictionary *data = @{@"identifier1":@"test",@"identifier2":@(1),@"identifier3":@(true)};
[self trackCustomEvent:@"your-event-name" eventData:data];

Verify you have added "-ObjC" in Other Linker Flags section in Xcode.

/ctp

app-analytics-services.com

Traceparent Header Generation

Not Implemented yet, Once implemented will be auto-collected.

No planned date as of now.

Application Not Responding

Not Implemented yet, Once implemented will be auto-collected.

No planned date as of now.

Network Request

Supports

• NSURLSession

• NSURLConnection

Screen View

We support:

• iOS/ tvOS Native

• Swift UI

App Crashes

We support collecting:

• Any exception after conviva is initialised

• Will be trying to send the crash details before the application exits due to crash

We don't support:

• Any crash before conviva is initialised

• If we cannot send before the application exit, it will be attempted only after next launch, which will be discarded if sent after 90 seconds of original crash

• Memory corruptions & dangling pointers crashes (EXC_BAD_ACCESS KERN_INVALID_ADDRESS) are missing

• All Web Browsers

• Smart TV’s Web Apps

• HTML-based Web Apps

• React-based Web Apps

• Angular-based Web Apps

The definition of a page view event depends on the type of application:

• For Multi-Page Applications (MPAs), each full page load counts as a new view.

• For Single-Page Applications (SPAs), a page view may be triggered by a route or URL path change.

Optionally call trackPageView() based on how navigation is handled in the specific app, to enable the associated metric Average Largest Contentful Paint Time.

Call trackPageView() whenever a significant page navigation occurs, such as a full page load, route change, or in-app view transition, to track page views. You have complete control over when to trigger trackPageView(). Conviva recommends calling trackPageView() only after a page is ready, meaning the content is both visible and usable. Avoid invoking it during the initial DOM load.

Example:

trackPageView(); // Uses document.title
trackPageView({ title: "Custom Page Title" });

If you skip the trackPageView() call during a navigation event, that page view won’t be recorded. Hence, the associated metric (Average Largest Contentful Paint Time) will not be displayed correctly in the Pulse dashboard. Remember, Conviva does not auto-capture any missing page views.

• Get Client ID:

import {
	convivaAppTracker,
	getClientId,
} from '@convivainc/conviva-js-appanalytics';

convivaAppTracker({
	appId: 'YOUR_APP_NAME_AS_STRING',
	convivaCustomerKey: 'CONVIVA_ACCOUNT_CUSTOMER_KEY',
	appVersion: '1.1.0',
});

// Always call getClientId() after initializing convivaAppTracker()
clientId = getClientId();

• Set Client ID:

import {
	convivaAppTracker,
	getClientId,
} from '@convivainc/conviva-js-appanalytics';

// Always call setClientId() before initializing convivaAppTracker() to set a specific clientId
setClientId(clientId);

convivaAppTracker({
	appId: 'YOUR_APP_NAME_AS_STRING',
	convivaCustomerKey: 'CONVIVA_ACCOUNT_CUSTOMER_KEY',
	appVersion: '1.1.0',
});

Use the trackCustomEvent() API to track all kinds of events that are not auto-collected.

This API provides 2 fields to describe the tracked events:

name - Name of the custom event

data - Any type of data in JSON format.

import { trackCustomEvent } from '@convivainc/conviva-js-appanalytics';

let customData = {
	identifier1: 'test',
	identifier2: 1,
	identifier3: true,
};

trackCustomEvent({
	name: 'Custom Event Name',
	data: customData,
});

Why are my application page views not being auto-collected?

When you navigate within a single-page application, new pages are not loaded, so they will not be tracked as page views.

To track page views in single page applications, call the trackpageview API.

Is Conviva SDK hosted on a CDN?

Conviva prefers using npn as it improves the speed of execution at app startup. Due to this reason, it is not hosted on a CDN.

To host the DPI SDK on a CDN, use the script version of the JS DPI SDK: GitHub - Conviva/conviva-js-script-appanalytics: App analytics sensor specially made for JS script tag based integrations.

Network Request

We support only :

• XMLHttpRequest

• fetch

Page View

Page Title can be passed as part of trackPageView api, if title is not set then page title is autodetected using api document.title when trackPageView api is called.

Button Click Tracking

We support click on input element type button or if element tag name is button.

if customer application adds stopPropagation or preventDefault in there button click event listener then conviva will not be able to detect the click.

Link Click Tracking

We support link click tracking on element if element tag name is .

Application Not Responding

Not Implemented yet, implemented will be

Autocollected

App or Page Load Time

Not available, will be via API

Application Not Responding

Traceparent Header Generation