Premiers pas

L'intégralité des fonctionnalités de Timelight est disponible à travers cette API. Cette page de documentation vous aidera à vous familiariser avec les entités Timelight ainsi qu'avec le processus d'analyse dans sa globalité.

L'analyse Timelight

Une source, ou capteur, est un élément sur lequel sont rattachés des relevés d'activité : toute donnée est rattachée à une source. Pour chaque capteur, il est nécessaire de définir une période de référence, utilisée pour l'entraînement des algorithmes Timelight.

L'entraînement des algorithmes permet d'identifier les différentes journées types liées au capteur, et ce pour chaque capteur.

Une fois les profils types de journées identifiés, le système est en capacité de détecter automatiquement les écarts des données récentes par rapport à ces profil types. Des alertes sont alors générées par rapport à ces écarts.

Modules de l'API

Pour faciliter sa compréhension, L'API est découpée en différents modules au périmètre distinct :

  • User: authentification et informations utilisateur
  • Import: import de données et création de sources au format JSON
  • Alert: lecture et traitement utilisateur des alertes et du référentiel d'alerte
  • View Helper: vues simplifiées destinées à l'affichage
  • AI: déclenchement de traitements d'intelligence artificielle
  • Prevision: lecture, sauvegarde et mise à jour des planifications
  • Day: lecture et mise à jour des données d'activité
  • Model: lecture et mise à jour des profils types de journée
  • Source: lecture et mise à jour des métadonnées liées aux sources
  • Source Group: lecture et mise à jour des regroupements de capteurs
  • Day Context: lecture et mise à jour des données contextuelles (météo, température)
  • Day Trend: lecture et mise à jour des données de tendance
  • ImportCsv: import de données et création de sources au format CSV

Commencer à utiliser l'API

Vous pouvez dès maintenant commencer à utiliser l'API Timelight grâce aux identifiants fournis par notre équipe.

Pour commencer à utiliser l'API, vous pouvez:

  1. Vous authentifier
  2. Importer une première source de données
  3. Récupérer les alertes

Pour aller plus loin

Pour utiliser pleinement l'API Timelight, vous pourriez:

  1. Consulter la référence complète de l'API
  2. Configurer vos propres modèles
  3. Générer un client pour votre language de programmation