Developer Guide: Integrating AnalyShield for Web Analytics


Introduction

AnalyShield is an innovative analytics platform designed to provide developers and website managers with detailed insights into web user interactions. Our system meticulously tracks user activities, including clicks, page views, form submissions, and session details (start and end times), offering a granular view of user engagement. This guide outlines the process of integrating AnalyShield into your web application to leverage these analytics capabilities.

Account and App Management

  1. Account Creation: Begin by visiting AnalyShield registration to create your AnalyShield account. Fill in the required information and follow the prompts to set up your account.
  2. App Management: Once logged in, you can create and manage multiple applications within your dashboard. Each application represents a separate web system you wish to track analytics for. Navigate to the Apps section and go to API Keys then click [Create new app] to start tracking a new web application.

API Key Generation

For each application you create, AnalyShield generates a unique API key. This key is essential for segmenting and securing your analytics data. To find your API key, create a new app in the API Key section.
Note: Keep your API key confidential it will only be shown to you once to prevent unauthorized access/ to your analytics data.

Script Tag Integration

To start collecting data with AnalyShield, simply include a script tag at the bottom of your web page, right before the closing body tag. Replace YOUR_API_KEY_HERE with your actual API key generated in the previous step. Below id the tag you'll include in your website.

<script src="https://analy-shield.banit.co.ke/tracker/js?api_key=YOUR_API_KEY_HERE"></script>

Ensure the script tag is added to every page you wish to track on your website. The script asynchronously collects and sends data to AnalyShield without affecting your website's load time.

Understanding Your Analytics

After integrating AnalyShield, you can view and analyze the collected data in your dashboard. Our platform offers various metrics and insights, including:

  • Click Tracking: Insights into what your users are clicking on most frequently.
  • Page Views: A breakdown of the most visited pages on your site.
  • Form Submissions: Analysis of form submission rates and behaviors.
  • Session Details: Duration of user sessions, including start and end times.
Utilize these insights to optimize your web application, improve user experience, and make informed decisions.

Support and Community

If you encounter any issues or have questions:

  • Visit our Developer Forum: Engage with other developers and our team for support and tips.
  • Contact Support: For direct assistance, reach out to our support team via info@banit.co.ke.
We're continuously working to enhance AnalyShield based on your feedback. Join our community and contribute to the future of web analytics.

Was this guide helpful?

We're dedicated to providing you with the best experience possible. Your feedback helps us improve our documentation and platform. Share your thoughts and suggestions with us.