1. Accueil
  2. Guides de l'utilisateur
  3. Documentation API RESTful
  4. API de comptage de données [bêta]
Recherche...

API de comptage de données [bêta]

Description Appel de ce point de terminaison en fournissant le type de données de comptage et d'objet de charge utile de requête dans la chaîne JSON pour obtenir les données de comptage au format JSON.
Endpoint

{CubeHostAddress}/API/v1/load

{CubeHostAddress} : https://cube.footfallcam.com (si vous utilisez une solution sur site, veuillez consulter l'assistance FootfallCam sur l'adresse de l'hôte)
Method POSTEZ
En-têtes
  1. Autorisation : retour de la valeur du jeton de API "Générer un jeton d'accès" en fournissant le nom d'utilisateur et le mot de passe
Corps - Exemple JSON {
    "mettre en doute": {
        "les mesures": [
            "CeNomCube.FC01_SUM",
            "CeNomCube.FC01_AVG",
            "CeNomCube.FC02_SUM",
            "CeNomCube.FC02_AVG"
        ],
        "timeDimensions": [
            {
                "dimension": "CeNomCube.Heure",
                "plagedate": [
                    "2021-10-01T10:00:00.000",
                    "2021-10-31"
                ],
                "granularité": "heure"
            }
        ],
        "commande": [
            [
                "CeNomCube.FC01_SUM",
                "desc"
            ]
        ],
        "filtres": [
            {
                "member": "ThisCubeName.CompanyId",
                "opérateur": "est égal à",
                "valeurs": [
                    "1001"
                ]
            },
            {
                "member": "CeCubeName.BranchId",
                "opérateur": "est égal à",
                "valeurs": [
                    "2001",
                    "2001"
                ]
            },
            {
                "member": "CeCubeName.BranchName",
                "opérateur": "est égal à",
                "valeurs": [
                    "NomBranche1",
                    "NomBranche2"
                ]
            },
            {
                "member": "ThisCubeName.AreaId",
                "opérateur": "est égal à",
                "valeurs": [
                    "3001",
                    "3002",
                    "3003"
                ]
            }
        ],
        "dimensions": [
            "ThisCubeName.CompanyId",
            "CeCubeName.CompanyName",
            "ThisCubeName.BranchId",
            "CeCubeName.BranchName",
            "ThisCubeName.AreaId",
            "CeNomCube.NomZone"
        ],
        "limite" : 50000
    }
}
Description du corps

Le nom du cube doit être mentionné dans la charge utile et ses champs disponibles dépendent du cube sélectionné. Se il vous plaît se référer liste de cubes pour les détails du cube

  1. query (object) : pour définir la charge utile des données de requête
  2. mesures (liste de chaînes) : Pour définir la liste des codes métriques et le type d'agrégation.
  3. timeDimensions (list of object) : Contient un objet pour définir les paramètres liés au temps
    1. dimension (string) : pour spécifier la dimension pour l'application des paramètres liés au temps
    2. dateRange (liste de chaînes) : pour spécifier l'heure de début et de fin de la requête de données. Exemple : "2021-10-01T10:00:00.000", "2021-10-31"
    3. granularity (string) : Pour définir la granularité temporelle des données. Exemple : minute, heure, jour, semaine, mois, année
  4. order (list of list of string) : Pour spécifier l'ordre des données. Chaque liste mineure contient le nom du champ pour appliquer la commande et le type de commande respectif. Exemple : ["ThisCubeName.FC01_SUM", "desc"]
  5. filtres (liste d'objets) : Pour définir le filtrage des données de la requête.
    1. membre (chaîne) : pour spécifier la dimension d'application du filtre.
    2. operator (string) : Pour définir le type de filtre. Exemple : égal, notEquals, contains, notContains
    3. values ​​(liste de chaînes) : pour spécifier une valeur pour le filtrage des données.
  6. dimensions (liste de chaînes) : pour spécifier la dimension à afficher dans les données de résultat, similaire à l'instruction 'Select' dans la requête SQL.
  7. limit (entier, facultatif) : pour spécifier le nombre maximal d'enregistrements de données renvoyées. La valeur par défaut sera 10000 (si elle n'est pas spécifiée dans la charge utile), la valeur maximale est 50000.
Réponse 1 - Exemple JSON {
    "error": "Continuer d'attendre",
    "étape": {
        "stage": "Exécution de la requête",
        "temps écoulé": 5003
    }
}
Réponse 1 Description La réponse "Continue Wait" indique simplement que le backend peut prendre un certain temps pour exécuter la requête et renvoyer le résultat. Ce n'est pas dû à un échec d'appel d'API, la requête s'exécute sur le backend. Réessayez ensuite et l'API renverra le résultat une fois que le backend aura exécuté la requête.
Réponse 2 - Exemple JSON {
    "mettre en doute": {},
    "Les données": [
{
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.NomZone": nul,
            "cube3.Time.hour": "2022-01-15T11:00:00.000",
            "cube3.Time": "2022-01-15T11:00:00.000",
            "cube3.FC01_SUM": 200,
            "cube3.FC01_MAX": 180,
            "cube3.FC01_AVG": 100,
            "cube3.FC01_MIN": 20,
            "cube3.FC02_SUM": 188,
            "cube3.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.NomZone": nul,
            "cube3.Time.hour": "2022-01-07T15:00:00.000",
            "cube3.Time": "2022-01-07T15:00:00.000",
            "cube3.FC01_SUM": 175,
            "cube3.FC01_MAX": 100,
            "cube3.FC01_AVG": 87.5,
            "cube3.FC01_MIN": 75,
            "cube3.FC02_SUM": 174,
            "cube3.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.NomZone": nul,
            "cube3.Time.hour": "2022-01-15T13:00:00.000",
            "cube3.Time": "2022-01-15T13:00:00.000",
            "cube3.FC01_SUM": 171,
            "cube3.FC01_MAX": 151,
            "cube3.FC01_AVG": 85.5,
            "cube3.FC01_MIN": 20,
            "cube3.FC02_SUM": 166,
            "cube3.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",
    "annotation": {},
    "dataSource": "par défaut",
    "dbType": "prestodb",
    "extDbType": "cubestore",
    "externe": faux,
    "slowQuery": faux
}
Réponse 2 Description Le résultat des données de comptage sera dans la section 'données' en tant que liste d'objets, d'autres informations supplémentaires peuvent être supprimées à l'avenir.
Mis à jour le février 22, 2023