1. INÍCIO
  2. Guias do usuário
  3. Documentação da API RESTful
  4. API de contagem de dados [Beta]
Procurando...

API de contagem de dados [Beta]

Descrição Chamar este ponto de extremidade fornecendo o tipo de objeto de carga útil de consulta e dados de contagem na string JSON para obter dados de contagem no formato JSON.
Ponto final

{CubeHostAddress}/API/v1/load

{CubeHostAddress}: https://cube.footfallcam.com (se você estiver usando uma solução local, consulte o suporte da FootfallCam no endereço do host)
Forma POST
Cabeçalhos
  1. Autorização : Retorno do valor do token de API 'GenerateAccessToken' fornecendo o nome de usuário e senha
Corpo - Exemplo JSON {
    "consulta": {
        "medidas": [
            "ThisCubeName.FC01_SUM",
            "ThisCubeName.FC01_AVG",
            "ThisCubeName.FC02_SUM",
            "ThisCubeName.FC02_AVG"
        ],
        "timeDimensões": [
            {
                "dimension": "ThisCubeName.Time",
                "dateRange": [
                    "2021-10-01T10:00:00.000",
                    "2021-10-31"
                ],
                "granularidade": "hora"
            }
        ],
        "pedido": [
            [
                "ThisCubeName.FC01_SUM",
                "desc"
            ]
        ],
        "filtros": [
            {
                "member": "ThisCubeName.CompanyId",
                "operador": "igual",
                "valores": [
                    "1001"
                ]
            },
            {
                "member": "ThisCubeName.BranchId",
                "operador": "igual",
                "valores": [
                    "2001",
                    "2001"
                ]
            },
            {
                "member": "ThisCubeName.BranchName",
                "operador": "igual",
                "valores": [
                    "Nome do Ramo1",
                    "Nome do Ramo2"
                ]
            },
            {
                "member": "ThisCubeName.AreaId",
                "operador": "igual",
                "valores": [
                    "3001",
                    "3002",
                    "3003"
                ]
            }
        ],
        "dimensões": [
            "ThisCubeName.CompanyId",
            "ThisCubeName.CompanyName",
            "ThisCubeName.BranchId",
            "ThisCubeName.BranchName",
            "ThisCubeName.AreaId",
            "ThisCubeName.AreaName"
        ],
        "limite": 50000
    }
}
Descrição do corpo

O nome do cubo deve ser mencionado na carga útil e seus campos disponíveis dependem do cubo selecionado. Consulte lista de cubo para detalhes do cubo

  1. query (objeto): para definir a carga útil para dados de consulta
  2. medidas (lista de string) : Para definir a lista de códigos de métrica e tipo de agregação.
  3. timeDimensions (lista de objetos): Contém um objeto para definir parâmetros relacionados ao tempo
    1. dimension (string): para especificar a dimensão para aplicar parâmetros relacionados ao tempo
    2. dateRange (lista de strings): Para especificar a data de início e término da consulta de dados. Exemplo: "2021-10-01T10:00:00.000", "2021-10-31"
    3. granularidade (string): Para definir a granularidade de tempo para os dados. Exemplo: minuto, hora, dia, semana, mês, ano
  4. order (lista de lista de strings): Para especificar a ordenação dos dados. Cada lista secundária contém o nome do campo para aplicar a ordenação e o respectivo tipo de ordenação. Exemplo: ["ThisCubeName.FC01_SUM", "desc"]
  5. filtros (lista de objetos): Para definir a filtragem dos dados da consulta.
    1. member (string) : Para especificar a dimensão para aplicar o filtro.
    2. operador (string): Para definir o tipo de filtro. Exemplo: equals, notEquals, contém, notContains
    3. valores (lista de string) : Para especificar o valor para filtrar dados.
  6. dimensões (lista de strings): Para especificar a dimensão a ser exibida nos dados do resultado, semelhante à instrução 'Select' na consulta SQL.
  7. limit (int, opcional): Para especificar a contagem máxima de registros de dados retornados. O valor padrão será 10000 (se não for especificado na carga útil), o valor máximo é 50000.
Resposta 1 - Exemplo de JSON {
    "erro": "Continuar esperando",
    "etapa": {
        "stage": "Executando consulta",
        "tempo decorrido": 5003
    }
}
Descrição da Resposta 1 A resposta 'Continue Wait' é simplesmente uma indicação de que o backend pode levar algum tempo para executar a consulta e retornar o resultado. Não é devido a falha na chamada da API, a consulta está sendo executada no back-end. Tente novamente depois e a API retornará o resultado assim que o back-end terminar de executar a consulta.
Resposta 2 - Exemplo de JSON {
    "consulta": {},
    "dados": [
{
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.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
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.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
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.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"
            }
        ]
    ],
    "usedPreAggregations": {},
    "transformedQuery": {},
    "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1",
    "anotação": {},
    "dataSource": "padrão",
    "dbType": "prestodb",
    "extDbType": "cubestore",
    "externo": falso,
    "slowQuery": falso
}
Descrição da Resposta 2 O resultado da contagem de dados estará na seção 'dados' como lista de objetos, outras informações adicionais podem ser removidas no futuro.
Atualizado em fevereiro 22, 2023