React User Analytics Package - README

Overview

Welcome to the documentation for the react-useranalytics package! This package is designed to help you integrate user analytics seamlessly into your React applications. With react-useranalytics, you can gain insights into how users interact with your application, track events, and make informed decisions to enhance user experience.

Installation

You can easily install the package using npm:

npm install react-useranalytics --save

or with Yarn:

yarn add react-useranalytics

Usage

1. Import the package:

   import userAnalytics from "react-useranalytics";

2. Add your API url to get the page analytics [ method: "POST", "Content-Type": "application/json",]:

   userAnalytics.apiKey = "YOUR API URL";

API Reference

UserAnalyticsProvider Props

• apiKey string: Your user analytics API key.
• setUserId (string): Your user id to track page views based on user.
• set ({page : string, title:string, subTitle?:string}): Page properties.

Examples

• Tracking page views:

  import userAnalytics from "react-useranalytics";

  const MyComponent = () => {
    const [userIdFlag, setUserIdFlag] = useState(true);

   userAnalytics.apiKey = "YOUR API URL";
   userAnalytics.apiCallTime = 30; //@default 30 Minutes 
    useEffect(() => {
       if (userId && userIdFlag) {
           userAnalytics.setUserId(userId);
           setUserIdFlag(false);
       }
       if (userId) {
           userAnalytics.set({
               page: "page_url", //**Mandatory**
               title: "page_title", //**Mandatory**
               subTitle: "page_subtitle",//**Optional**
           });
       }
       return () => {
           userAnalytics.logTime();
       };
   }, [ userId, userIdFlag]);

    return (
       <App/>
    );
  };

Response

 "pages":"[{
   "page":"page_url",
   "duration":"page_duration",
   "title":"page_title",
   "subTitle":"page_subtitle"
 },{
   "page":"page_url",
   "duration":"page_duration",
   "title":"page_title",
 },{
   "page":"page_url",
   "duration":"page_duration",
   "title":"page_title",
    "subTitle":"page_subtitle"
 }
 ]",
 "session":"{
   "startTime":"start_timestamp",
   "endTime":"end_timestamp",
   "duration":"session_duration",
   "latitude":"latitude",
   "longitude":"longitude",
   "user":"userId",
 }"

Support and Issues

If you encounter any issues or have questions about using this package, please feel free to open an issue on GitHub.

License

This package is released under the MIT License.

We hope that the react-useranalytics package serves your needs for integrating user analytics into your React application. If you have any feedback or suggestions, we'd love to hear from you!