Se connecterCommencer gratuitement
Référence APIHeatmap d'activité des transferts
GET/v1/analytics/heatmap

Heatmap d'activité des transferts

Renvoie une grille 7 jours x 24 heures comptant les transferts créés par tranche horaire sur la fenêtre choisie.

2 min de lectureTélécharger en PDF

Réponse exemple

{
  "cells": [
    [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      1,
      3,
      5,
      8,
      6,
      4,
      7,
      9,
      5,
      3,
      2,
      1,
      0,
      0,
      0,
      0,
      0
    ],
    [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      2,
      4,
      6,
      7,
      5,
      6,
      8,
      4,
      2,
      1,
      0,
      0,
      0,
      0,
      0,
      0
    ],
    [
      0,
      0,
      0,
      0,
      0,
      0,
      1,
      2,
      4,
      6,
      9,
      7,
      5,
      8,
      10,
      6,
      3,
      1,
      0,
      0,
      0,
      0,
      0,
      0
    ],
    [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      1,
      3,
      5,
      7,
      6,
      4,
      5,
      7,
      5,
      2,
      1,
      0,
      0,
      0,
      0,
      0,
      0
    ],
    [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      2,
      3,
      4,
      5,
      4,
      3,
      4,
      6,
      3,
      1,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ],
    [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      1,
      1,
      2,
      2,
      1,
      1,
      2,
      1,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ],
    [
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      1,
      1,
      1,
      0,
      1,
      1,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  ],
  "total": 247
}
GET/v1/analytics/heatmapCompte les transferts créés du workspace actif, ventilés par jour de la semaine et par heure.

Cet endpoint produit une heatmap d'activité : une matrice de 7 lignes (jours, du lundi au dimanche) par 24 colonnes (heures, de 0 à 23) où chaque cellule contient le nombre de transferts créés dans cette tranche horaire. Les comptes sont calculés sur les transferts du workspace actif uniquement, sur une fenêtre glissante de 7, 30 ou 90 jours se terminant à l'instant de la requête.

Comportement notable : la ventilation par jour et par heure utilise le fuseau du serveur (les valeurs getDay()/getHours() côté serveur), et le jour est réindexé pour que l'index 0 corresponde au lundi (et l'index 6 au dimanche). Aucune pagination n'est appliquée : la réponse agrège l'ensemble des lignes de la fenêtre.

Authentification

Cet endpoint requiert une session utilisateur connectée (cookie de session), pas de clé API à scope dédié : il s'appuie sur getAuthedContext() et résout automatiquement le workspace actif depuis le contexte. Aucun scope spécifique n'est exigé. En l'absence de session valide, la requête est rejetée avec un statut 401.

Paramètres de requête

ParamètreTypeRequisDescription
rangestringNonTaille de la fenêtre en jours. Valeurs reconnues : 7, 30, 90. Toute autre valeur (ou paramètre absent) retombe sur 30 par défaut.

Réponse

La réponse JSON contient deux champs. cells est un tableau de 7 sous-tableaux de 24 entiers : cells[jour][heure] est le nombre de transferts créés ce jour de la semaine, à cette heure (jour 0 = lundi, heure 0 = minuit). total est le nombre total de transferts comptabilisés sur la fenêtre, soit la somme de toutes les cellules.

ChampTypeDescription
cellsnumber[][]Matrice 7x24. cells[jour][heure] = nombre de transferts. Index jour 0..6 = lundi..dimanche, index heure 0..23.
totalnumberNombre total de transferts pris en compte sur la fenêtre (somme des cellules).

Erreurs

CodeQuandRésolution
401Session absente, expirée ou invalide (getAuthedContext n'a pas pu résoudre l'utilisateur).Se connecter et rejouer la requête avec un cookie de session valide.

Voir aussi