API de datos de conteo [Beta]

Descripción	Llamar a este punto final proporcionando el tipo de datos de recuento y el objeto de carga útil de consulta en una cadena JSON para obtener los datos de recuento en formato JSON.
Punto final	{CubeHostAddress}/API/v1/cargar {CubeHostAddress}: https://cube.footfallcam.com (si está utilizando una solución local, consulte con FootfallCam Support en la dirección del host)
Método	PUBLICAR
Cabezales	Autorización: retorno de valor de token de API 'Generar token de acceso' proporcionando el nombre de usuario y la contraseña
Cuerpo - Ejemplo JSON	{ "consulta": { "medidas": [ "EsteNombreCubo.FC01_SUM", "EsteNombreCubo.FC01_AVG", "EsteNombreCubo.FC02_SUM", "EsteNombreCubo.FC02_AVG" ], "timeDimensions": [ { "dimensión": "EsteNombreCubo.Tiempo", "rango de fechas": [ "2021-10-01T10:00:00.000", "2021-10-31" ], "granularidad": "hora" } ], "pedido": [ [ "EsteNombreCubo.FC01_SUM", "desc" ] ], "filtros": [ { "miembro": "EsteNombreCubo.CompanyId", "operador": "igual", "valores": [ "1001" ] }, { "miembro": "EsteNombreDeCubo.BranchId", "operador": "igual", "valores": [ "2001", "2001" ] }, { "miembro": "EsteNombreCubo.NombreSucursal", "operador": "igual", "valores": [ "NombreSucursal1", "NombreSucursal2" ] }, { "miembro": "EsteNombreCubo.AreaId", "operador": "igual", "valores": [ "3001", "3002", "3003" ] } ], "dimensiones": [ "EsteNombreCubo.IdEmpresa", "EsteNombreCubo.NombreEmpresa", "EsteNombreDeCubo.BranchId", "EsteNombreCubo.NombreSucursal", "EsteNombreCubo.AreaId", "EsteNombreCubo.NombreArea" ], "límite": 50000 } }
Descripción del cuerpo	El nombre del cubo debe mencionarse en la carga útil y sus campos disponibles dependen del cubo seleccionado. Consulte lista de cubo para detalles de cubo consulta (objeto): para definir la carga útil para los datos de consulta medidas (lista de cadena) : Para definir la lista de códigos de métrica y el tipo de agregación. timeDimensions (lista de objetos): contiene un objeto para definir parámetros relacionados con el tiempo dimensión (cadena) : Para especificar la dimensión para aplicar parámetros relacionados con el tiempo rango de fechas (lista de cadenas): para especificar la fecha de inicio y finalización de la consulta de datos. Ejemplo: "2021-10-01T10:00:00.000", "2021-10-31" granularidad (cadena): para definir la granularidad de tiempo para los datos. Ejemplo: minuto, hora, día, semana, mes, año orden (lista de lista de cadena) : Para especificar el orden de los datos. Cada lista secundaria contiene el nombre del campo para aplicar el orden y el respectivo tipo de orden. Ejemplo: ["EsteNombreCubo.FC01_SUM", "desc"] filtros (lista de objetos): para definir el filtrado de datos de consulta. miembro (cadena): para especificar la dimensión para aplicar el filtro. operador (cadena) : Para definir el tipo de filtro. Ejemplo: es igual, no es igual a, contiene, no contiene valores (lista de cadenas) : Para especificar el valor para filtrar datos. dimensiones (lista de cadenas): para especificar la dimensión que se mostrará en los datos de resultados, similar a la declaración 'Seleccionar' en la consulta SQL. límite (int, opcional): para especificar el recuento máximo de registros de datos devueltos. El valor predeterminado será 10000 (si no se especifica en la carga útil), el valor máximo es 50000.
Respuesta 1 - Ejemplo JSON	{ "error": "Continuar espera", "escenario": { "stage": "Ejecutando consulta", "tiempo transcurrido": 5003 } }
Respuesta 1 Descripción	La respuesta 'Continue Wait' simplemente indica que el backend puede tardar algún tiempo en ejecutar la consulta y devolver el resultado. No se debe a una llamada API fallida, la consulta se está ejecutando en el backend. Vuelva a intentarlo después y la API devolverá el resultado una vez que el backend termine de ejecutar la consulta.
Respuesta 2 - Ejemplo JSON	{ "consulta": {}, "datos": [ { "cubo3.CompanyId": "18330", "cube3.CompanyName": "DemoCompany", "cubo3.BranchId": "23097", "cube3.BranchName": "UKSite01", "cubo3.AreaId": "-1", "cubo3.AreaName": nulo, "cube3.Time.hour": "2022-01-15T11:00:00.000", "cube3.Time": "2022-01-15T11:00:00.000", "cubo3.FC01_SUM": 200, "cubo3.FC01_MAX": 180, "cubo3.FC01_AVG": 100, "cubo3.FC01_MIN": 20, "cubo3.FC02_SUM": 188, "cubo3.FC02_MAX": 171, "cubo3.FC02_AVG": 94, "cubo3.FC02_MIN": 17 }, { "cubo3.CompanyId": "18330", "cube3.CompanyName": "DemoCompany", "cubo3.BranchId": "23097", "cube3.BranchName": "UKSite01", "cubo3.AreaId": "-1", "cubo3.AreaName": nulo, "cube3.Time.hour": "2022-01-07T15:00:00.000", "cube3.Time": "2022-01-07T15:00:00.000", "cubo3.FC01_SUM": 175, "cubo3.FC01_MAX": 100, "cubo3.FC01_AVG": 87.5, "cubo3.FC01_MIN": 75, "cubo3.FC02_SUM": 174, "cubo3.FC02_MAX": 95, "cubo3.FC02_AVG": 87, "cubo3.FC02_MIN": 79 }, { "cubo3.CompanyId": "18330", "cube3.CompanyName": "DemoCompany", "cubo3.BranchId": "23097", "cube3.BranchName": "UKSite01", "cubo3.AreaId": "-1", "cubo3.AreaName": nulo, "cube3.Time.hour": "2022-01-15T13:00:00.000", "cube3.Time": "2022-01-15T13:00:00.000", "cubo3.FC01_SUM": 171, "cubo3.FC01_MAX": 151, "cubo3.FC01_AVG": 85.5, "cubo3.FC01_MIN": 20, "cubo3.FC02_SUM": 166, "cubo3.FC02_MAX": 146, "cubo3.FC02_AVG": 83, "cubo3.FC02_MIN": 20 } ], "lastRefreshTime": "2022-01-19T07:35:41.259Z", "refreshKeyValues": [ [ { "refresh_key": "13688147" } ] ], "agregaciones previas usadas": {}, "Consulta transformada": {}, "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1", "anotación": {}, "Fuente de datos": "predeterminado", "dbType": "prestodb", "extDbType": "almacén de cubos", "externo": falso, "slowQuery": falso }
Respuesta 2 Descripción	El resultado de los datos de conteo estará en la sección 'datos' como una lista de objetos, es posible que se elimine otra información adicional en el futuro.

Actualizado en febrero 22, 2023