APIs - Tutoriais

GetAnalytic

54 views 14/07/2021 17/08/2021 rodolfo-andrade 0

Consulta informações de um componente do tipo analytic

Payload de entrada:

{
  "analyticId": "string"  //Identificador do componente analytic
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms/queries/getAnalytic" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "analyticId": "string" }"

Responses:

200 OK
{
  "analytic": {                                // Um componente, plugável a uma página, que provê a exibição de informações através de um gráfico
    "id": "string",                            // Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico
    "name": "string",                          // Nome do analytic
    "title": "string",                         // Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome
    "chart": {                                 // Informações de gráficos e suas associações
      "type": "BAR",                           // Tipo do gráfico
      "category": {                            // Categoria do gráfico (opcional para o tipo de gráfico GAUGE)
        "schema": "string",                    // Nome do schema
        "table": "string",                     // Nome da tabela
        "column": "string",                    // Nome da coluna
        "label": "string",                     // Label da coluna
        "function": "AVG",                     // Informa uma função aplicada na coluna
        "precision": 0,                        // Precisão para formatação do valor
        "prefix": "string",                    // Prefixo do label
        "sufix": "string",                     // Sufixo do label
        "mask": "string"                       // Máscara da coluna
      },
      "series": [                              // Conjunto de valores a serem exibidos (se o tipo de gráfico for pizza, somente um conjunto é aceito)
        {
          "column": {                          // Coluna que o conjunto de dados será vinculado
            "schema": "string",                // Nome do schema
            "table": "string",                 // Nome da tabela
            "column": "string",                // Nome da coluna
            "label": "string",                 // Label da coluna
            "function": "AVG",                 // Informa uma função aplicada na coluna
            "precision": 0,                    // Precisão para formatação do valor
            "prefix": "string",                // Prefixo do label
            "sufix": "string",                 // Sufixo do label
            "mask": "string"                   // Máscara da coluna
          },
          "label": "string"                    // Descrição do conjunto
        }
      ],
      "datasetId": "string",                   // Identificador do dataset que será vinculado ao gráfico
      "filter": {},                            // Filtros
      "order": [                               // A ordenação dos registros
        {
          "schema": "string",                  // Nome do schema
          "table": "string",                   // Nome da tabela
          "column": "string",                  // Coluna em que será aplicado o filtro
          "function": "AVG",                   // Função aplicada
          "order": "ASC"                       // Tipo de ordenação (Valores padrões: ASC e DESC)
        }
      ]
    },
    "preferredSize": {                         // Tamanho de preferência
      "height": 0,                             // Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels
      "width": 0                               // Largura
    },
    "tags": [                                  // Tags associadas a esse analytic
      "string"
    ],
    "properties": [                            // Registro de uma propriedade
      {
        "name": "string",                      // Nome da propriedade
        "value": "string"                      // Valor da propriedade
      }
    ],
    "createdBy": "string",                     // Usuário criador do componente
    "createdDate": "2021-07-14T14:19:31.644Z"  // Data de criação do componente
  }
}

Tipos de gráficos padrões:

    BAR – “Barra”
    STACKED_BAR – “Barra empilhada”
    COLUMN – “Coluna”
    STACKED_COLUMN – “Coluna empilhada”
    PIE – “Pizza”
    AREA – “Área”
    LINE – “Linha”
    TABLE – “Tabela”
    BUBBLE – “Bolha”
    GAUGE – “Medidor”
    COUNTER – “Contador”
    RADAR – “Radar”
    MAP – “Mapa”
    FILTER – “Filtro”

Tipos de funções padrões:

    AVG – “Média”
    COUNT – “Contar”
    MAX – “Máximo”
    MIN – “Mínimo”
    SUM – “Soma”
    COUNT_DISTINCT – “Contar distintos”

400 Bad Request (Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente)
{
  "message": "Descrição do erro",
  "errorCode": "codigoDoErro",
  "reason": "BAD_REQUEST",
  "domain": "platform",
  "service": "cms"
}

401 Unauthorized (Usuário ou senha inválido)
{
  "error_description": "Descrição do erro",
  "error": "codigo_do_erro"
}

404 Not Found (Analytic não encontrado)
{
  "message": "Descrição do erro",
  "errorCode": "codigoDoErro",
  "reason": "OBJECT_NOT_FOUND",
  "domain": "platform",
  "service": "cms"
}

403 Forbidden (Permissão negada)

Este artigo foi útil para você?