API del server V9

Questa sezione descrive l'elenco dei cubi disponibili e le loro dimensioni e misure. I cubi sono richiamabili da cube.footfallcam.com tramite API REST o API SQL. I dati restituiti sono regolati dalla policy di archiviazione dei dati: Appendice C - Definizione delle metriche V2 - FootfallCam. Anche i dati restituiti sono limitati a 1000000 di righe.

Si prega di fare riferimento a Esempio di API REST e API SQL di seguito un esempio su come inviare un'API

informazioni_sul_sito_ffc
Questo cubo fornisce informazioni per ogni area di ingresso principale di ogni sito. Restituisce tutte le combinazioni di valori delle dimensioni selezionate e aggrega le misure selezionate.
Dimensioni  
Nome della ditta Il nome dell'azienda proprietaria del sito.
Nome del sito Il nome del sito.
ID sito L'identificativo del sito.
Codice sito Il nome in codice del sito.
Nome del gruppo di siti Il nome del gruppo del sito.
DataVerificataSito Datetime verificato del sito. Restituisce '1900-01-01 00:00:00' se il sito non è verificato.
ffc_sito_sommario
Questo cubo fornisce informazioni per ogni area di ingresso principale di ogni sito. Gli utenti possono restringere la selezione del sito e l'intervallo di tempo per un caricamento più rapido delle query. Restituisce tutte le combinazioni di valori delle dimensioni selezionate e aggrega le misure selezionate.
Dimensioni  
Nome della ditta Il nome dell'azienda proprietaria del sito.
Nome del sito Il nome del sito.
ID sito L'identificativo del sito.
Codice sito Il nome in codice del sito.
Nome del gruppo di siti Il nome del gruppo del sito.
Ora Ora locale del sito. La granularità temporale rispetta la documentazione metrica. Gli input di granularità validi sono ('giorno','ora','minuto'). La granularità predefinita è 'giorno'. Questa dimensione non può essere utilizzata insieme alla dimensione Time15Minute.
Tempo15Minuti Ora locale del sito arrotondata per difetto a un intervallo di 15 minuti. Questa dimensione non può essere utilizzata insieme alla dimensione Tempo.
È operativo 1 se il sito è operativo, 0 altrimenti.
IsSiteVerificato 1 se il sito è verificato, 0 altrimenti.
Stato di aggregazione

"Completato" se non ci sono lacune nei dati. "Dati mancanti" se c'è una lacuna nei dati. "Pre-controllo" se in attesa di controllo. "Dati in ritardo" se ci sono dati in ritardo e saranno aggiornati a "Completato" o "Dati mancanti" in futuro.

Stato di aggregazione_A04

Lo stato è applicabile per granularità giornaliera. Il valore è "Completato" se non manca alcuna aggregazione. "Dati mancanti" se sono presenti dati grezzi ma nessun dato aggregato. "Dati insufficienti" se la durata della visita è calcolata in base al numero di visitatori e il numero di visitatori è 0. "Pre-controllo" se in attesa di verifica.

Misure Tutte le misure sottostanti sono considerate solo all'ingresso principale. Per maggiori dettagli su di esse, fare riferimento alla documentazione metrica: Appendice C - Definizione delle metriche V2 - FootfallCam.
A01 (Conteggio totale dei passi) Conteggio del numero di persone che entrano nell'area di ingresso principale del sito.
A02 (Conteggio totale dei visitatori) Conteggio del numero di persone in uscita dall'area di ingresso principale del sito.

A03 (Occupazione media)

Numero medio di persone rilevate su quel sito.
A04 (Tempo medio di permanenza) Tempo medio trascorso dalle persone su quel sito.
A18 (Numero totale di bambini in conteggio) Numero di bambini che accedono all'area d'ingresso principale del sito.
A05 (Conteggio totale del traffico esterno) Numero di visitatori rilevati all'esterno.
B01 (Tasso di consegna medio) Frazione del traffico pedonale totale che visita il sito.
B02 (Tasso medio di ritorno dei visitatori) Percentuale di visitatori che tornano sul sito negli ultimi 60 giorni.
riepilogo_area_ffc
Questo cubo fornisce informazioni per ogni area all'interno di un sito. Gli utenti possono restringere il sito, l'area e l'intervallo di tempo per un caricamento più rapido delle query. Restituisce tutte le combinazioni di valori delle dimensioni selezionate e aggrega le misure selezionate.
Dimensioni  
Nome della ditta Il nome dell'azienda proprietaria dell'area.
Nome del sito Il nome del sito proprietario dell'area.
NomeArea Il nome dell'area del sito.
NomeGruppoArea Il nome del gruppo a cui appartiene l'area.
Nome tipo gruppo area Nome del tipo di gruppo a cui appartiene l'area.
Ora Ora locale del sito. La granularità temporale rispetta la documentazione metrica. Gli input di granularità validi sono ('giorno','ora','minuto'). La granularità predefinita è 'giorno'.
Misure Per ulteriori dettagli a riguardo fare riferimento alla documentazione metrica: Appendice C - Definizione delle metriche V2 - FootfallCam.
A01 (Conteggio totale dei passi) Numero di visitatori che accedono all'area.
A02 (Conteggio totale dei visitatori) Numero di visitatori che escono dall'area.
A03 (Occupazione media) Numero di visitatori rilevati nell'area.

Understaff_A03 (Sottopersonale)

Il numero del personale è inferiore alla soglia inferiore.

Overstaff_A03 (Sovrapersonale)

Il numero del personale è superiore alla soglia massima.

Optimalstaff_A03 (Personale ottimale)

Il numero del personale è superiore alla soglia superiore e inferiore alla soglia inferiore.
A04 (Durata media della visita) Tempo medio trascorso dai visitatori nell'area.
A18 (Numero totale di bambini in conteggio) Numero di bambini che accedono all'area.
A05 (Conteggio totale del traffico esterno) Numero di visitatori rilevati al di fuori dell'area.
B01 (Tasso di consegna medio) Frazione del traffico pedonale totale che visita il sito.
B02 (Tasso medio di ritorno dei visitatori) Percentuale di visitatori che tornano nella zona negli ultimi 60 giorni.
riepilogo_dispositivo_ffc
Questo cubo fornisce informazioni per ogni dispositivo. Gli utenti possono restringere il sito e l'intervallo di tempo per un caricamento più rapido delle query. Restituisce tutte le combinazioni di valori delle dimensioni selezionate e aggrega le misure selezionate.
Dimensioni  
ID azienda L'ID dell'azienda proprietaria del dispositivo.
Nome della ditta Il nome dell'azienda proprietaria del dispositivo.
ID sito L'ID del sito a cui è assegnato il dispositivo.
Nome del sito Nome del sito a cui è assegnato il dispositivo.
AziendaSeriale Un numero di serie assegnato al dispositivo.
ID fotocamera Identificativo del dispositivo della fotocamera in formato intero.
Nome telecamera Nome assegnato al dispositivo della fotocamera.
Ora Ora locale del sito. La granularità temporale rispetta la documentazione metrica. Gli input di granularità validi sono ('giorno','ora','minuto'). La granularità predefinita è 'giorno'.
Misure Per ulteriori dettagli a riguardo fare riferimento alla documentazione metrica: Appendice C - Definizione delle metriche V2 - FootfallCam.
A01 (Conteggio totale dei passi) Numero di visitatori che transitano nella fila IN del dispositivo.
A02 (Conteggio totale dei visitatori) Numero di visitatori che attraversano la linea OUT del dispositivo.
A03 (Occupazione media) Numero di visitatori rilevati nel raggio d'azione del sensore del dispositivo.
A04 (Durata media della visita) Tempo trascorso dai visitatori nel raggio d'azione del sensore del dispositivo.
A18 (Numero totale di bambini in conteggio) Numero di bambini che passano attraverso la fila IN del dispositivo.
A05 (Conteggio totale del traffico esterno)  Numero di visitatori rilevati dal sensore Wi-Fi del dispositivo.
riepilogo_pattuglia
Questa vista fornisce metriche relative alle pattuglie per ogni sito e istanza di sessione. Restituisce tutte le combinazioni di valori delle dimensioni selezionate relative a azienda, sito e sessione e aggrega le misure di conformità delle pattuglie, come le pattuglie completate e quelle perse.
Dimensioni  
ID azienda L'ID dell'azienda proprietaria del dispositivo.
Nome della ditta Il nome dell'azienda proprietaria del dispositivo.
Nome del sito Nome del sito a cui è assegnato il dispositivo.
ID sito L'identificativo del sito.
Codice sito Il nome in codice del sito.
Tipo di negozio Tipologia del negozio.
ID sessione L'ID della sessione di pattuglia.
DataInizioIstanzaSessioneOra L'orario di inizio programmato della sessione di pattuglia
SessionInstanceEndDateTime L'orario di fine programmato della sessione di pattuglia
ActualStartTime L'orario effettivo di inizio della sessione di pattugliamento.
ActualEndTime L'orario effettivo di fine della sessione di pattuglia
Zona coperta Le zone coperte dalla specifica sessione di pattugliamento.
Percentuale di copertura della zona Percentuale di zone coperte rispetto a tutte le zone esistenti durante la sessione di pattugliamento.
Misure  
J01 (Pattuglie completate) Numero totale di pattugliamenti completati.
J02 (Pattuglie scomparse) Numero totale di pattuglie disperse.
riepilogo_occupazione

Questa vista fornisce metriche di occupazione per ciascuna area all'interno di un sito, insieme a configurazioni, raggruppamenti e contesto operativo correlati. Consente l'analisi dei livelli di occupazione nel tempo e nello spazio.

Dimensioni  
ID azienda L'ID dell'azienda proprietaria del dispositivo.
Nome della ditta Il nome dell'azienda proprietaria del dispositivo.
Nome del sito Nome del sito a cui è assegnato il dispositivo.
ID sito L'identificativo del sito.
Codice sito Il nome in codice del sito.
Tipo di negozio Tipologia del negozio.
ID zona L'identificatore dell'area.
Codice Area Il nome in codice della zona.
NomeArea Nome della zona.
NomeGruppoArea Nome del gruppo dell'area.
ID configurazione ID basato sul ruolo.
Nome configurazione Nome della configurazione.
Ora Marca temporale dei dati di occupazione.
Data di esecuzione Data di entrata in vigore del verbale di occupazione.
Misure  

CA03 (Occupazione media con configurazione)

Occupazione media in base all'ID configurazione (personale).

Esempio di API REST

Questa sezione spiega come ottenere dati tramite REST API. L'utente può utilizzare applicazioni come Postino per chiamare l'API. Il corpo della query è in formato JSON. L'API REST richiede un'intestazione del token del portatore che può essere ottenuta tramite Token di accesso - FootfallCamL'esempio seguente mostra come ottenere il totale dei visitatori giornalieri nel conteggio del Sito A e del Sito B dal cubo ffc_site_summary dal 1° ottobre 2024 al 25 ottobre 2024. Limita inoltre il numero di righe restituite a 10000.

RICHIEDI
endpoint https://cube.footfallcam.com/API/v1/load
Metodo POST
testata Portatore [Token di accesso]
Carico utile
{
    "richiesta": {
        "misure": [ // Metriche aggregate (affluenza, ecc.)
            "ffc_site_summary.A01",  
            "ffc_site_summary.A05",
        ],
        "dimensioni": [ // Contesto di raggruppamento (CompanyId, AreaName, ecc.)
            "ffc_site_summary.NomeSito"
        ],
        "timeDimensions": [ // Tempo (per specificare la granularità e l'intervallo temporale)
            {
                "dimensione": "ffc_site_summary.Time",
                "granularità": "giorno", // Può essere minuto, ora, giorno, ecc.
                "intervallo di date": [
                    "2024-10-01",
                    "2024-10-25"
                ]
            }
        ],
        "filtri": [
            {
                "membro": "ffc_site_summary.SiteName",
                "operatore": "uguale",
                "valori": [
                    "Sito A",
                    "Sito B"
                ]
            }
        ]
,
        "ordine": [
            [
                "ffc_site_summary.NomeSito",
                "asc"
            ],
            [
                "ffc_site_summary.Time",
                "asc"
            ]
        ],
        "limite": 10000
    }
}
Risposta
"dati": [
        {
            "ffc_site_summary.SiteName": "Sito 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": "Sito 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": "Sito 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
        }
]
 

Esempio di API SQL

Questa sezione descrive come ottenere dati dal server V9 tramite SQL API. Applicazioni popolari come PowerBI and Dcastoro usa questo metodo. L'esempio seguente mostra come ottenere il totale dei visitatori giornalieri in count dal cubo site_summary con dimensione branch name dal 1 ottobre 2024 al 25 ottobre 2024. Limita inoltre il numero di righe restituite a 10000.

URL di connessione cubo.footfallcam.com:6432
Guidatore Postgresql
Istruzione SQL

SELEZIONA BranchName, DATE_TRUNC('giorno',Ora), A01
DA ffc_site_summary
DOVE Tempo TRA '2024-10-01' E '2024-10-25'
LIMITE 10000

Aggiornato ad aprile 2, 2026