Cette section décrit la liste des cubes disponibles, ainsi que leurs dimensions et mesures. Ces cubes sont accessibles via la commande `cube`.footfallcam.com utilise l'API REST ou l'API SQL. Les données renvoyées sont soumises à une politique de stockage des données : Annexe C - Définition des indicateurs V2 - FootfallCam. Les données renvoyées sont également limitées à 1000000 XNUMX XNUMX lignes.
S'il vous plaît se référer à Exemple d'API REST et d'API SQL Vous trouverez ci-dessous un exemple de la manière d'envoyer une API.
| ffc_site_info | |
| Ce cube fournit des informations pour chaque entrée principale de chaque site. Il renvoie toutes les combinaisons de valeurs des dimensions sélectionnées et agrège les mesures sélectionnées. | |
| Dimensions | |
| Nom de la compagnie | Le nom de la société propriétaire du site. |
| Nom du site | Le nom du site. |
| Identifiant du site | L'identifiant du site. |
| Code du site | Le nom de code du site. |
| Nom du groupe de sites | Le nom du groupe du site. |
| SiteVérifiéDate | Date et heure vérifiées du site. Renvoie « 1900-01-01 00:00:00 » si le site n'est pas vérifié. |
| résumé_du_site_ffc | |
| Ce cube fournit des informations pour chaque zone d'entrée principale de chaque site. Les utilisateurs peuvent affiner la sélection de sites et la plage horaire pour accélérer le temps de chargement des requêtes. Il renvoie toutes les combinaisons de valeurs des dimensions sélectionnées et regroupe les mesures sélectionnées. | |
| Dimensions | |
| Nom de la compagnie | Le nom de la société propriétaire du site. |
| Nom du site | Le nom du site. |
| Identifiant du site | L'identifiant du site. |
| Code du site | Le nom de code du site. |
| Nom du groupe de sites | Le nom du groupe du site. |
| Heure | Heure locale du site. La granularité temporelle respecte la documentation des métriques. Les entrées de granularité valides sont ('day','hour','minute'). La granularité par défaut est 'day'. Cette dimension ne peut pas être utilisée avec la dimension Time15Minute. |
| Durée15 minutes | Heure locale du site arrondie à un intervalle de 15 minutes. Cette dimension ne peut pas être utilisée avec la dimension Heure. |
| Est en fonctionnement | 1 si le site est opérationnel, 0 sinon. |
| EstSiteVérifié | 1 si le site est vérifié, 0 sinon. |
| Statut d'agrégation |
« Terminé » s'il n'y a pas de trou dans les données. « Données manquantes » s'il y a un trou dans les données. « Prévérification » s'il y a une vérification en attente. « Données tardives » s'il y a des données tardives et qu'elles seront mises à jour vers « Terminé » ou « Données manquantes » à l'avenir. |
| AggregationStatus_A04 |
Le statut s'applique à la granularité journalière. La valeur est « Terminé » si aucune agrégation n'est manquante. « Données manquantes » s'il existe des données brutes, mais pas de données agrégées. « Données insuffisantes » si la durée de la visite est calculée en fonction de la fréquentation et que celle-ci est nulle. « Pré-vérification » si la vérification est en attente. |
| d'atténuation | Toutes les mesures ci-dessous ne sont prises en compte qu'à l'entrée principale. Pour plus de détails à ce sujet, veuillez vous référer à la documentation métrique : Annexe C - Définition des indicateurs V2 - FootfallCam. |
| A01 (Nombre total de pas dans le décompte) | Nombre de pas qui pénètrent dans la zone d'entrée principale du site. |
| A02 (Nombre total de pas sortants) | Nombre de pas qui sortent de la zone d'entrée principale du site. |
| Nombre moyen de personnes détectées sur ce site. | |
| A04 (Temps de séjour moyen) | Temps moyen passé par les gens sur ce site. |
| A18 (Nombre total de pas des enfants dans le décompte) | Nombre d'enfants qui entrent dans la zone d'entrée principale du site. |
| A05 (Nombre total de véhicules extérieurs) | Nombre de visiteurs détectés à l'extérieur du site. |
| B01 (Taux moyen de remise des dossiers) | Fraction du trafic piétonnier total qui visite le site. |
| B02 (Taux moyen de retour des visiteurs) | Fraction de visiteurs qui reviennent sur le site au cours des 60 derniers jours. |
| résumé_de_la_zone_ffc | |
| Ce cube fournit des informations pour chaque zone d'un site. Les utilisateurs peuvent affiner le site, la zone et la période pour accélérer le temps de chargement des requêtes. Il renvoie toutes les combinaisons de valeurs des dimensions sélectionnées et regroupe les mesures sélectionnées. |
|
| Dimensions | |
| Nom de la compagnie | Le nom de l'entreprise propriétaire de la zone. |
| Nom du site | Le nom du site propriétaire de la zone. |
| Nom de zone | Le nom de la zone du site. |
| Nom du groupe de zones | Le nom du groupe auquel appartient la zone. |
| Nom du type de groupe de zones | Le nom du type du groupe auquel appartient la zone. |
| Heure | Heure locale du site. La granularité temporelle respecte la documentation des métriques. Les entrées de granularité valides sont ('jour','heure','minute'). La granularité par défaut est 'jour'. |
| d'atténuation | Pour plus de détails à leur sujet, veuillez vous référer à la documentation métrique : Annexe C - Définition des indicateurs V2 - FootfallCam. |
| A01 (Nombre total de pas dans le décompte) | Nombre de visiteurs qui entrent dans la zone. |
| A02 (Nombre total de pas sortants) | Nombre de visiteurs qui sortent de la zone. |
| A03 (Taux d'occupation moyen) | Nombre de visiteurs détectés dans la zone. |
| Le nombre d'employés est inférieur au seuil inférieur. | |
| Le nombre d'employés est supérieur au seuil supérieur. | |
| Le nombre d'employés est supérieur au seuil supérieur et inférieur au seuil inférieur. | |
| A04 (Durée moyenne de la visite) | Temps moyen passé par les visiteurs dans la zone. |
| A18 (Nombre total de pas des enfants dans le décompte) | Nombre d'enfants qui entrent dans la zone. |
| A05 (Nombre total de véhicules extérieurs) | Nombre de visiteurs détectés à l'extérieur de la zone. |
| B01 (Taux moyen de remise des dossiers) | Fraction du trafic piétonnier total qui visite le site. |
| B02 (Taux moyen de retour des visiteurs) | Fraction de visiteurs qui reviennent dans la région au cours des 60 derniers jours. |
| Résumé de l'appareil ffc | |
| Ce cube fournit des informations pour chaque appareil. Les utilisateurs peuvent affiner le site et la plage horaire pour accélérer le temps de chargement des requêtes. Il renvoie toutes les combinaisons de valeurs des dimensions sélectionnées et regroupe les mesures sélectionnées. |
|
| Dimensions | |
| ID de l'entreprise | L'identifiant de la société propriétaire de l'appareil. |
| Nom de la compagnie | Le nom de la société propriétaire de l'appareil. |
| Identifiant du site | L'identifiant du site auquel l'appareil est attribué. |
| Nom du site | Le nom du site auquel l'appareil est attribué. |
| Numéro de série de l'entreprise | Un numéro de série attribué à l'appareil. |
| ID de la caméra | L'identifiant du périphérique de caméra au format entier. |
| Nom de la caméra | Le nom attribué au périphérique de caméra. |
| Heure | Heure locale du site. La granularité temporelle respecte la documentation des métriques. Les entrées de granularité valides sont ('jour','heure','minute'). La granularité par défaut est 'jour'. |
| d'atténuation | Pour plus de détails à leur sujet, veuillez vous référer à la documentation métrique : Annexe C - Définition des indicateurs V2 - FootfallCam. |
| A01 (Nombre total de pas dans le décompte) | Nombre de visiteurs qui passent par la ligne IN de l'appareil. |
| A02 (Nombre total de pas sortants) | Nombre de visiteurs qui passent par la ligne OUT de l'appareil. |
| A03 (Taux d'occupation moyen) | Nombre de visiteurs détectés dans la portée du capteur de l'appareil. |
| A04 (Durée moyenne de la visite) | Temps passé par les visiteurs dans la portée du capteur de l'appareil. |
| A18 (Nombre total de pas des enfants dans le décompte) | Nombre d'enfants qui passent par la ligne IN de l'appareil. |
| A05 (Nombre total de véhicules extérieurs) | Nombre de visiteurs détectés par le capteur Wi-Fi de l'appareil. |
| résumé_de_la_patrouille | |
| Cette vue fournit des indicateurs de patrouille pour chaque site et instance de session. Elle renvoie toutes les combinaisons de valeurs des dimensions sélectionnées (entreprise, site et session) et regroupe les indicateurs de conformité des patrouilles, tels que les patrouilles terminées et manquées. | |
| Dimensions | |
| ID de l'entreprise | L'identifiant de la société propriétaire de l'appareil. |
| Nom de la compagnie | Le nom de la société propriétaire de l'appareil. |
| Nom du site | Le nom du site auquel l'appareil est attribué. |
| Identifiant du site | L'identifiant du site. |
| Code du site | Le nom de code du site. |
| Type de magasin | Type de magasin. |
| SessionId | L'identifiant de la session de patrouille. |
| Date et heure de début de l'instance de session | L'heure de début prévue de la session de patrouille |
| Date et heure de fin de l'instance de session | L'heure de fin prévue de la session de patrouille |
| Heure de début réelle | L'heure de début réelle de la session de patrouille. |
| Heure de fin réelle | L'heure de fin réelle de la session de patrouille |
| Zone couverte | Les zones couvertes lors de la séance de patrouille particulière. |
| Pourcentage de couverture de zone | Le pourcentage de zones couvertes sur toutes les zones existantes lors de la session de patrouille. |
| d'atténuation | |
| J01 (Patrouilles terminées) | Nombre total de patrouilles effectuées. |
| J02 (Patrouilles disparues) | Nombre total de patrouilles manquantes. |
| résumé_occupation | |
|
Cette vue fournit des indicateurs d'occupation pour chaque zone d'un site, ainsi que les configurations, les regroupements et le contexte opérationnel associés. Elle permet d'analyser les niveaux d'occupation dans le temps et l'espace. |
|
| Dimensions | |
| ID de l'entreprise | L'identifiant de la société propriétaire de l'appareil. |
| Nom de la compagnie | Le nom de la société propriétaire de l'appareil. |
| Nom du site | Le nom du site auquel l'appareil est attribué. |
| Identifiant du site | L'identifiant du site. |
| Code du site | Le nom de code du site. |
| Type de magasin | Type de magasin. |
| ID de zone | L'identifiant de la zone. |
| Indicatif régional | Le nom de code de la zone. |
| Nom de zone | Nom de la zone. |
| Nom du groupe de zones | Nom du groupe de la zone. |
| ConfigurationId | Identifiant basé sur le rôle. |
| Nom de configuration | Nom de la configuration. |
| Heure | Horodatage des données d'occupation. |
| Date d'opération | Date d'exploitation du registre d'occupation. |
| d'atténuation | |
| Taux d'occupation moyen basé sur l'ID de configuration (personnel). | |
Exemple d'API REST
Cette section explique comment obtenir des données via l'API REST. L'utilisateur peut utiliser une application comme Facteur pour appeler l'API. Le corps de la requête est au format JSON. L'API REST nécessite un en-tête de jeton porteur qui peut être obtenu via Jeton d'accès - FootfallCam. L'exemple ci-dessous montre comment obtenir le nombre total de visiteurs quotidiens dans le décompte du site A et du site B à partir du cube ffc_site_summary du 1er octobre 2024 au 25 octobre 2024. Il limite également le nombre de lignes renvoyées à 10000 XNUMX.
| Demander | |
| Endpoint | https://cube.footfallcam.com/API/v1/load |
| Méthode | POSTEZ |
| En-tête | Porteur [Jeton d'accès] |
| Charge utile |
{
"mettre en doute": {
"mesures" : [ // Métriques agrégées (Fréquentation, etc.)
"ffc_site_summary.A01",
"ffc_site_summary.A05",
],
"dimensions": [ // Contexte de regroupement (CompanyId, AreaName, etc.)
"ffc_site_summary.Nom du site"
],
"timeDimensions": [ // Temps (Pour spécifier la granularité et la plage temporelles)
{
"dimension": "ffc_site_summary.Heure",
"granularité" : "jour", // Peut être minute, heure, jour, etc.
"plagedate": [
"2024-10-01",
"2024-10-25"
]
}
],
"filtres": [
{
"membre": "ffc_site_summary.SiteName",
"operator": "est égal à",
"valeurs": [
"Site A",
"Site B"
]
}
]
,
"commande": [
[
"ffc_site_summary.SiteName",
"asc"
],
[
"ffc_site_summary.Heure",
"asc"
]
],
"limite": 10000
}
}
|
| Réponse |
"Les données": [
{
"ffc_site_summary.SiteName": "Site A",
"ffc_site_summary.Time.day": "2024-10-01T00:00:00.000",
"ffc_site_summary.Time": "2024-10-01T00:00:00.000",
"ffc_site_summary.A01": 62,
"ffc_site_summary.A05": 92
},
{
"ffc_site_summary.SiteName": "Site A",
"ffc_site_summary.Time.day": "2024-10-02T00:00:00.000",
"ffc_site_summary.Time": "2024-10-02T00:00:00.000",
"ffc_site_summary.A01": 46,
"ffc_site_summary.A05": 58
},
...
{
"ffc_site_summary.SiteName": "Site B",
"ffc_site_summary.Time.day": "2024-10-25T00:00:00.000",
"ffc_site_summary.Time": "2024-10-25T00:00:00.000",
"ffc_site_summary.A01": 92,
"ffc_site_summary.A05": 148
}
]
|
Exemple d'API SQL
Cette section décrit comment obtenir des données à partir du serveur V9 à l'aide de l'API SQL. Applications populaires telles que PowerBI et Castor utilisez cette méthode. L'exemple ci-dessous montre comment obtenir le nombre total de visiteurs quotidiens dans le nombre du cube site_summary avec la dimension nom de branche du 1er octobre 2024 au 25 octobre 2024. Il limite également le nombre de lignes renvoyées à 10000 XNUMX.
| URL de connexion | cube.footfallcam.com : 6432 |
| Chauffeur | Postgresql |
| Instruction SQL |
SÉLECTIONNEZ BranchName, DATE_TRUNC('jour',Heure), A01 |