Português
English
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/getAnalytic" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "analyticId": "string" }"
Responses:
200 OK
{
// Um componente, plugável a uma página, que provê a exibição de informações através de um gráfico
"analytic": {
// Identificador do analytics seguindo o padrão: analytic://tenantDomain/identificadorUnico
"id": "string",
// Nome do analytic
"name": "string",
// Título a ser exibido podendo ser uma chave de tradução no padrão platform.cms.nome
"title": "string",
// Informações de gráficos e suas associações
"chart": {
// Tipo do gráfico
"type": "BAR",
// Categoria do gráfico (opcional para o tipo de gráfico GAUGE)
"category": {
// Nome do schema
"schema": "string",
// Nome da tabela
"table": "string",
// Nome da coluna
"column": "string",
// Label da coluna
"label": "string",
// Informa uma função aplicada na coluna
"function": "AVG",
// Precisão para formatação do valor
"precision": 0,
// Prefixo do label
"prefix": "string",
// Sufixo do label
"sufix": "string",
// Máscara da coluna
"mask": "string"
},
// Conjunto de valores a serem exibidos (se o tipo de gráfico for pizza, somente um conjunto é aceito)
"series": [
{
// Coluna que o conjunto de dados será vinculado
"column": {
// Nome do schema
"schema": "string",
// Nome da tabela
"table": "string",
// Nome da coluna
"column": "string",
// Label da coluna
"label": "string",
// Informa uma função aplicada na coluna
"function": "AVG",
// Precisão para formatação do valor
"precision": 0,
// Prefixo do label
"prefix": "string",
// Sufixo do label
"sufix": "string",
// Máscara da coluna
"mask": "string"
},
// Descrição do conjunto
"label": "string"
}
],
// Identificador do dataset que será vinculado ao gráfico
"datasetId": "string",
// Filtros
"filter": {},
// A ordenação dos registros
"order": [
{
// Nome do schema
"schema": "string",
// Nome da tabela
"table": "string",
// Coluna em que será aplicado o filtro
"column": "string",
// Função aplicada
"function": "AVG",
// Tipo de ordenação (Valores padrões: ASC e DESC)
"order": "ASC"
}
]
},
// Tamanho de preferência
"preferredSize": {
// Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels
"height": 0,
// Largura
"width": 0
},
// Tags associadas a esse analytic
"tags": [
"string"
],
// Registro de uma propriedade
"properties": [
{
// Nome da propriedade
"name": "string",
// Valor da propriedade
"value": "string"
}
],
// Usuário criador do componente
"createdBy": "string",
// Data de criação do componente
"createdDate": "2021-07-14T14:19:31.644Z"
}
}
Tipos de gráficos padrões:
- BAR – “Barra”
- STACKED_BAR – “Barra empilhada”
- COLUMN – “Coluna”/li>
- STACKED_COLUMN – “Coluna empilhada”/li>
- 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"
}
403 Forbidden - Permissão negada
404 Not Found - Analytic não encontrado
{
"message": "Descrição do erro",
"errorCode": "codigoDoErro",
"reason": "OBJECT_NOT_FOUND",
"domain": "platform",
"service": "cms"
}
