telodash-js
v1.1.1
Published
SDK officiel TeloDash — Analytics + Graphiques pour développeurs
Maintainers
Readme
telodash-js
SDK officiel TeloDash — Analytics SaaS pour développeurs africains.
Ce que c'est
TeloDash est un SaaS analytics. Tu crées un compte, tu crées un projet, tu obtiens une API key et tu commences à tracker les événements de ton app en quelques minutes.
Le SDK telodash-js te permet de :
- Envoyer des événements depuis n'importe quelle app (Next.js, React, Node.js...)
- Intégrer des graphiques directement dans ton dashboard avec TeloDashChart
Installation
npm install telodash-js recharts
Démarrage rapide
- Crée un compte sur https://telodash.telopex.online
- Crée un projet dans ton dashboard
- Copie ton API key
- Installe le SDK et commence à tracker
Tracking d'événements
import { TeloDash } from 'telodash-js'
const td = new TeloDash('TON_API_KEY')
// Page vue td.pageview('/home') td.pageview('/dashboard', 'user123')
// Inscription / Connexion td.signup('user123') td.login('user123')
// Clic td.click('bouton-acheter', '/pricing')
// Événement custom td.track('purchase', { userId: 'user123', page: '/checkout', data: { amount: 25000, currency: 'FCFA' } })
Graphiques (bonus développeur)
TeloDashChart est un composant React réutilisable inclus dans le SDK. Il te permet d'afficher n'importe quelle donnée sous forme de graphique dans ton propre dashboard.
import { TeloDashChart } from 'telodash-js/react'
// Avec tes propres données <TeloDashChart data={[{ mois: 'Jan', ventes: 5000 }, { mois: 'Fev', ventes: 8000 }]} xKey="mois" yKey="ventes" type="bar" title="Mes ventes" color="#E2703A" />
// Avec données automatiques depuis TeloDash
Paramètres TeloDashChart
| Paramètre | Type | Description | |-----------|------|-------------| | type | line, bar, pie, area | Type de graphique | | data | array | Tes propres données (mode manuel) | | xKey | string | Clé de l'axe X | | yKey | string ou string[] | Clé(s) de l'axe Y | | color | string ou string[] | Couleur(s) hex | | height | number | Hauteur en px (défaut: 300) | | title | string | Titre du graphique | | showGrid | boolean | Afficher la grille | | showLegend | boolean | Afficher la légende | | apiKey | string | API key TeloDash (mode auto) | | projectId | string | ID projet TeloDash (mode auto) | | metric | pageviews, events, users | Métrique à afficher (mode auto) |
Note : TeloDashChart est un bonus pour les développeurs. Il n'est pas lié aux plans d'abonnement TeloDash.
Plans TeloDash
| Plan | Prix | Projets | Events/mois | |------|------|---------|-------------| | Gratuit | 0 FCFA | 1 | 5 000 | | Starter | 2 900 FCFA/mois | 3 | 50 000 | | Pro | 7 900 FCFA/mois | 10 | 500 000 | | Business | 19 900 FCFA/mois | Illimité | Illimité |
API Reference
| Méthode | Paramètres | Description | |---------|-----------|-------------| | pageview(page, userId?) | page: string | Tracker une page vue | | signup(userId) | userId: string | Tracker une inscription | | login(userId) | userId: string | Tracker une connexion | | click(element, page?) | element: string | Tracker un clic | | track(type, options?) | type: string | Événement custom |
Liens
- Dashboard : https://telodash.telopex.online
- Documentation : https://telodash.telopex.online/docs
- Pricing : https://telodash.telopex.online/pricing
- Telopex : https://telopex.online
- Support : [email protected]
