AppEQ Analytics SDK Integration Guide

Purpose

The AppEQ Analytics SDK enables clients to capture user interactions, track events, and send this data to the AppEQ platform for analysis and insights. By following the steps outlined below, you will set up the SDK to start collecting data specific to your domain.

Integration Steps

Include the SDK Script Add the following script to the <head> section of your application’s HTML:
```
<script src="https://app.appeq.ai/v2/sdk/tracker.min.js"></script>
```

Initialize the SDK Below the script tag, initialize the AppEQ Analytics SDK by adding the following code snippet:

<script> _AppEQAnalyticsSDK.init({ cookieDomain: {{domain}}, // Replace with your domain, e.g., "example.com" apiKey: '<provided by AppEQ team>', analyticsEndpoint: 'https://api1.appeq.ai/form/analytics/storeAnalytics', userId: userId, // Replace with the user's unique email ID or identifier metadata: { // Optional: Include any additional metadata you wish to track exampleKey: 'exampleValue' } }); </script>

Parameter Breakdown
- cookieDomain: Specify your application’s domain to associate cookies with the correct site. Example: "example.com".
- apiKey: Use the provided API key for authentication (ensure it is kept secure and not shared).
- analyticsEndpoint: This is the endpoint where analytics data will be sent. Keep this unchanged unless instructed otherwise.
- userId: Replace this placeholder with the unique identifier for your user, such as their email address or user ID in your system.
- metadata: (Optional) Include any additional key-value pairs to send custom data for tracking purposes.
Dynamic User ID Insertion Ensure that the userId value dynamically populates based on your application's context. For example, in a JavaScript-based web app, you might fetch the logged-in user’s email like this:
```
const userId = getCurrentUserEmail(); // Replace with your method to retrieve the email
```
Verify Integration
- Open your application in a browser.
- Inspect the network tab to confirm that analytics data is being sent to the endpoint (https://api1.appeq.ai/form/analytics/storeAnalytics).
- Check for any errors in the console and ensure all fields, especially userId, are populated correctly.

Security Considerations

Keep your API key confidential and avoid exposing it in publicly accessible repositories.
Only use secure methods to retrieve and handle user-specific information such as userId.

Support

For any questions or issues regarding the integration process, please contact the AppEQ support team at support@appeq.ai.

By following this guide, you will successfully integrate the AppEQ Analytics SDK, enabling your platform to capture valuable insights and improve user engagement.