@lukajekic/metrica-sdk
v1.0.7
Published
Metrica SDK connects your App with Metrica Cloud's server for monitoring traffic and Events on your website. Make sure you are using Vercel for deploying your frontend.
Readme
Metrica SDK
Metrica SDK offers you to integrate Metrica's API as easy as it could be
It offers basic analytics tracking and connects you with Metrica Cloud Dashboard.
Prerequisites
- Having an active Account on Metrica Cloud
- Having one active project and it's API Key
- Allowing forntend to make API calls to https://ipapi.com
- Having Node.JS installed
Installation
Install metrica-sdk with npm
npm install @lukajekic/metrica-sdk@latestIntegration
You can integrate Metrica in JavaScript or React.
-It's important to store the API Key in a secure environment, like .env file added to .gitignore.
JavaScript
import { CreateMetricaView, CreateMetricaEvent } from "https://cdn.jsdelivr.net/npm/@lukajekic/metrica-sdk@latest";
const API_KEY = "Metrica.VX8XQAJxBKvjxSGZOXSfcmp0eOsLO";
const projectID = "6958545069fa1fc9d5efe037";
//page view example
document.addEventListener("DOMContentLoaded", () => {
console.log("Tracking page view");
CreateMetricaView(API_KEY);
});
//btn click example
document.getElementById("btn").onclick = () => {
console.log("Tracking BTN Click");
CreateMetricaEvent(API_KEY, "695854e769fa1fc9d5efe042"); //Api key and event ID
};React
import React, { useEffect } from "react";
import { CreateMetricaView } from "@lukajekic/metrica-sdk";
const API_KEY = "Metrica.VX8XQAJxBKvjxSGZOXSfcmp0eOsLO";
const EVENT_ID = "695854e769fa1fc9d5efe042";
export default function App() {
// Page view (DOMContentLoaded equivalent)
useEffect(() => {
console.log("Tracking page view");
CreateMetricaView(API_KEY);
}, []);
const handleClick = () => {
console.log("Tracking BTN Click");
CreateMetricaEvent(API_KEY, EVENT_ID);
};
return (
<button id="btn" onClick={handleClick}>
Track Button Click
</button>
);
}
After creating an Account on Metrica Cloud, you can explore more detailed documentation, covering:
- Creating a Project
- Retrieving a project API Key
- Defining a Page and an Event
