1. Casa
  2. Guide per l'utente
  3. Documentazione API RESTful
  4. Conteggio dell'API dei dati [Beta]
Ricerca in corso ...

Conteggio dell'API dei dati [Beta]

Descrizione Chiamare questo endpoint fornendo il tipo di dati di conteggio e oggetto payload di query nella stringa JSON per ottenere i dati di conteggio in formato JSON.
endpoint

{IndirizzoHostCube}/API/v1/load

{CubeHostAddress}: https://cube.footfallcam.com (se utilizzi una soluzione on-premise, consulta l'assistenza FootfallCam sull'indirizzo host)
metodo POST
Headers
  1. Autorizzazione: valore del token restituito da API "GeneraAccessToken" fornendo il nome utente e la password
Corpo - Esempio JSON {
    "interrogazione": {
        "le misure": [
            "ThisCubeName.FC01_SUM",
            "QuestoNomeCubo.FC01_AVG",
            "ThisCubeName.FC02_SUM",
            "QuestoNomeCubo.FC02_AVG"
        ],
        "timeDimensions": [
            {
                "dimensione": "ThisCubeName.Time",
                "intervallo di date": [
                    "2021-10-01T10:00:00.000",
                    "2021-10-31"
                ],
                "granularità": "ora"
            }
        ],
        "ordine": [
            [
                "ThisCubeName.FC01_SUM",
                "discesa"
            ]
        ],
        "filtri": [
            {
                "member": "ThisCubeName.CompanyId",
                "operatore": "uguale",
                "i valori": [
                    "1001"
                ]
            },
            {
                "member": "ThisCubeName.BranchId",
                "operatore": "uguale",
                "i valori": [
                    "2001/XNUMX",
                    "2001"
                ]
            },
            {
                "member": "ThisCubeName.BranchName",
                "operatore": "uguale",
                "i valori": [
                    "NomeFiliale1",
                    "NomeFiliale2"
                ]
            },
            {
                "member": "ThisCubeName.AreaId",
                "operatore": "uguale",
                "i valori": [
                    "3001/XNUMX",
                    "3002/XNUMX",
                    "3003"
                ]
            }
        ],
        "dimensioni": [
            "ThisCubeName.CompanyId",
            "ThisCubeName.CompanyName",
            "ThisCubeName.BranchId",
            "ThisCubeName.BranchName",
            "ThisCubeName.AreaId",
            "QuestoNomeCubo.NomeArea"
        ],
        "limite" : 50000
    }
}
Descrizione del corpo

Il nome del cubo deve essere menzionato nel carico utile e i suoi campi disponibili dipendono dal cubo selezionato. Per favore, riferisci elenco di cubi per i dettagli del cubo

  1. query (oggetto): per definire il carico utile per i dati della query
  2. misure (elenco di stringhe): per definire l'elenco dei codici metrici e il tipo di aggregazione.
  3. timeDimensions (elenco di oggetti): contiene un oggetto per definire i parametri relativi al tempo
    1. dimensione (stringa): per specificare la dimensione per l'applicazione di parametri relativi al tempo
    2. dateRange (elenco di stringhe): per specificare la data e l'ora di inizio e fine per la query di dati. Esempio: "2021-10-01T10:00:00.000", "2021-10-31"
    3. granularity (string): per definire la granularità temporale per i dati. Esempio: minuto, ora, giorno, settimana, mese, anno
  4. order (elenco di elenchi di stringhe): per specificare l'ordinamento dei dati. Ciascun elenco secondario contiene il nome del campo per applicare l'ordine e il rispettivo tipo di ordinamento. Esempio : ["ThisCubeName.FC01_SUM", "desc"]
  5. filtri (elenco di oggetti): per definire il filtraggio dei dati della query.
    1. membro (stringa): per specificare la dimensione per l'applicazione del filtro.
    2. operator (stringa): per definire il tipo per il filtro. Esempio: equals, notEquals, contiene, notContains
    3. valori (elenco di stringhe): per specificare il valore per il filtraggio dei dati.
  6. dimensioni (elenco di stringhe): per specificare la dimensione da visualizzare nei dati dei risultati, in modo simile all'istruzione 'Seleziona' nella query SQL.
  7. limit (int, facoltativo): per specificare il numero massimo di record di dati restituiti. Il valore predefinito sarà 10000 (se non specificato nel carico utile), il valore massimo è 50000.
Risposta 1 - Esempio JSON {
    "errore": "Continua attesa",
    "fase": {
        "stage": "Esecuzione della query",
        "tempo trascorso": 5003
    }
}
Risposta 1 Descrizione La risposta "Continua in attesa" indica semplicemente che il back-end potrebbe impiegare del tempo per eseguire la query e restituire il risultato. Non è dovuto a una chiamata API non riuscita, la query è in esecuzione sul back-end. Riprova in seguito e l'API restituirà il risultato al termine dell'esecuzione della query da parte del back-end.
Risposta 2 - Esempio JSON {
    "interrogazione": {},
    "dati": [
{
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": nullo,
            "cube3.Time.hour": "2022-01-15T11:00:00.000",
            "cube3.Time": "2022-01-15T11:00:00.000",
            "cube3.FC01_SUM": 200,
            "cubo3.FC01_MAX": 180,
            "cube3.FC01_AVG": 100,
            "cube3.FC01_MIN": 20,
            "cube3.FC02_SUM": 188,
            "cubo3.FC02_MAX": 171,
            "cube3.FC02_AVG": 94,
            "cube3.FC02_MIN": 17
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": nullo,
            "cube3.Time.hour": "2022-01-07T15:00:00.000",
            "cube3.Time": "2022-01-07T15:00:00.000",
            "cube3.FC01_SUM": 175,
            "cubo3.FC01_MAX": 100,
            "cube3.FC01_AVG": 87.5,
            "cube3.FC01_MIN": 75,
            "cube3.FC02_SUM": 174,
            "cubo3.FC02_MAX": 95,
            "cube3.FC02_AVG": 87,
            "cube3.FC02_MIN": 79
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": nullo,
            "cube3.Time.hour": "2022-01-15T13:00:00.000",
            "cube3.Time": "2022-01-15T13:00:00.000",
            "cube3.FC01_SUM": 171,
            "cubo3.FC01_MAX": 151,
            "cube3.FC01_AVG": 85.5,
            "cube3.FC01_MIN": 20,
            "cube3.FC02_SUM": 166,
            "cubo3.FC02_MAX": 146,
            "cube3.FC02_AVG": 83,
            "cube3.FC02_MIN": 20
        }
],
    "lastRefreshTime": "2022-01-19T07:35:41.259Z",
    "refreshKeyValues": [
        [
            {
                "refresh_key": "13688147"
            }
        ]
    ],
    "usedPreAggregations": {},
    "transformedQuery": {},
    "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1",
    "annotazione": {},
    "dataSource": "predefinito",
    "dbType": "prestodb",
    "extDbType": "cubestore",
    "esterno": falso,
    "slowQuery": falso
}
Risposta 2 Descrizione Il risultato del conteggio dei dati sarà nella sezione "dati" come elenco di oggetti, altre informazioni aggiuntive potrebbero essere rimosse in futuro.
Aggiornato a febbraio 22, 2023