1. Home
  2. Anleitungen
  3. RESTful API-Dokumentation
  4. Zähldaten-API [Beta]
Suche ...

Zähldaten-API [Beta]

Beschreibung Aufruf dieses Endpunkts durch Angabe des Typs der Zähldaten und des Abfragenutzlastobjekts in einer JSON-Zeichenfolge, um Zähldaten im JSON-Format abzurufen.
Endpunkt

{CubeHostAdresse}/API/v1/load

{CubeHostAddress}: https://cube.footfallcam.com (wenn Sie eine lokale Lösung verwenden, wenden Sie sich bitte an den FootfallCam-Support bezüglich der Hostadresse)
Versandart jetzt lesen
Headers
  1. Autorisierung : Rückgabe des Tokenwerts von API 'GenerateAccessToken' durch Angabe von Benutzername und Passwort
Text - JSON-Beispiel {
    "Anfrage": {
        "Maße": [
            "DieserCubeName.FC01_SUM",
            "DieserCubeName.FC01_AVG",
            "DieserCubeName.FC02_SUM",
            "DieserCubeName.FC02_AVG"
        ],
        "ZeitDimensionen": [
            {
                "dimension": "DieserCubeName.Zeit",
                "Datumsbereich": [
                    "2021-10-01T10:00:00.000",
                    "2021-10-31"
                ],
                "Granularität": "Stunde"
            }
        ],
        "Befehl": [
            [
                "DieserCubeName.FC01_SUM",
                "absteigen"
            ]
        ],
        "Filter": [
            {
                "member": "ThisCubeName.CompanyId",
                "operator": "gleich",
                "Werte": [
                    "1001"
                ]
            },
            {
                "member": "DieserCubeName.BranchId",
                "operator": "gleich",
                "Werte": [
                    "2001",
                    "2001"
                ]
            },
            {
                "member": "DieserCubeName.BranchName",
                "operator": "gleich",
                "Werte": [
                    "Zweigname1",
                    "Zweigname2"
                ]
            },
            {
                "member": "ThisCubeName.AreaId",
                "operator": "gleich",
                "Werte": [
                    "3001",
                    "3002",
                    "3003"
                ]
            }
        ],
        "Maße": [
            "DieserCubeName.Firmen-ID",
            "DieserCubeName.Firmenname",
            "DieserCubeName.BranchId",
            "DieserCubeName.Zweigname",
            "DieserCubeName.AreaId",
            "DieserCubeName.AreaName"
        ],
        "Grenze": 50000
    }
}
Körperbeschreibung

Der Cube-Name muss in der Nutzlast erwähnt werden und die verfügbaren Felder hängen vom ausgewählten Cube ab. Siehe Liste der Würfel für Würfeldetails

  1. query (object) : Um Payload für Abfragedaten zu definieren
  2. Maßnahmen (Liste der Zeichenfolgen): Zum Definieren einer Liste von Metrikcodes und der Art der Aggregation.
  3. timeDimensions (Liste von Objekten): Enthält ein Objekt, um zeitbezogene Parameter zu definieren
    1. Dimension (String): Um die Dimension für die Anwendung zeitbezogener Parameter anzugeben
    2. dateRange (Liste von Zeichenfolgen): Um Start- und Endzeit für die Datenabfrage anzugeben. Beispiel: "2021-10-01T10:00:00.000", "2021-10-31"
    3. granularity (string) : Zum Definieren der Zeitgranularität für Daten. Beispiel: Minute, Stunde, Tag, Woche, Monat, Jahr
  4. order (list of list of string) : Um die Reihenfolge der Daten anzugeben. Jede Unterliste enthält Feldnamen, um die Ordnung und den jeweiligen Ordnungstyp anzuwenden. Beispiel: ["DieserCubeName.FC01_SUM", "desc"]
  5. Filter (Liste von Objekten): Um das Filtern von Abfragedaten zu definieren.
    1. Mitglied (Zeichenfolge): Um die Dimension für die Anwendung des Filters anzugeben.
    2. Operator (Zeichenfolge): Um den Typ für den Filter zu definieren. Beispiel: ist gleich, notEquals, enthält, notContains
    3. Werte (Liste von Zeichenfolgen): Um einen Wert zum Filtern von Daten anzugeben.
  6. dimensions (list of string) : Um die Dimension anzugeben, die in den Ergebnisdaten angezeigt werden soll, ähnlich der 'Select'-Anweisung in der SQL-Abfrage.
  7. limit (int, optional) : Um die maximale Datensatzanzahl der zurückgegebenen Daten anzugeben. Der Standardwert ist 10000 (falls nicht in der Nutzlast angegeben), der Höchstwert ist 50000.
Antwort 1 – JSON-Beispiel {
    "error": "Weiter warten",
    "Bühne": {
        "stage": "Abfrage wird ausgeführt",
        "verstrichene Zeit": 5003
    }
}
Antwort 1 Beschreibung Die Antwort „Continue Wait“ ist lediglich ein Hinweis darauf, dass das Backend möglicherweise einige Zeit benötigt, um die Abfrage auszuführen und das Ergebnis zurückzugeben. Es liegt nicht an einem fehlgeschlagenen API-Aufruf, die Abfrage wird im Backend ausgeführt. Versuchen Sie es danach erneut und die API gibt das Ergebnis zurück, sobald das Back-End die Abfrage beendet hat.
Antwort 2 – JSON-Beispiel {
    "Anfrage": {},
    "Daten": [
{
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "Demo-Unternehmen",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": null,
            "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": "Demo-Unternehmen",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": null,
            "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": "Demo-Unternehmen",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": null,
            "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",
    "Anmerkung": {},
    "dataSource": "Standard",
    "dbType": "prestodb",
    "extDbType": "cubestore",
    "extern": falsch,
    "slowQuery": falsch
}
Antwort 2 Beschreibung Das Ergebnis der Zähldaten wird im Abschnitt „Daten“ als Liste von Objekten angezeigt, andere zusätzliche Informationen werden möglicherweise in Zukunft entfernt.
Aktualisiert am Februar 22, 2023