APIs - Tutoriais

ListAnalytics

91 views 13/07/2021 26/07/2021 rodolfo-andrade 0

Retorna uma lista de todos os componentes do tipo analytics.

Payload de entrada:

{
  "searchValue": "string", // Parâmetro de busca por nome do analytic, uri ou tags
  "pagination": {          // Configurações de paginação de uma listagem. Não definido, retornará os 10 primeiros resultados.
    "pageNumber": 0,       // Número/índice da página retornado. A primeira página corresponde ao índice 0
    "pageSize": 0          // Quantidade de registros retornados por página
  }
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms/queries/listAnalytics" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "searchValue": "string", "pagination": { "pageNumber": 0, "pageSize": 0 } }"

Responses:

200 OK
{
  "analytics": {
    "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
    "tags": [                                 // Tags associadas a esse analytic
      "string"
    ],
    "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
    },
    "chartType": "BAR",                       // Tipo do gráfico a ser exibido
    "createdBy": "string",                    // Usuário criador do componente
    "createdDate": "2021-07-13T17:43:26.112Z" // Data de criação do componente
  },
  "listInformation": {                        // Informações sobre os resultados de listagem realizada
    "totalElements": 0,                       // Quantidade total de resultados encontrados
    "totalPages": 0                           // Quantidade total de páginas encontradas
  }
}

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”

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"
}

Este artigo foi útil para você?