APIs - Tutoriais

SetPageAnalyticFilter

37 views 27/07/2021 17/08/2021 rodolfo-andrade 0

Salva os filtros alterados do analytic na página para o usuário do contexto

Payload de entrada:

{
  "pageId": "string",      // Identificador da página
  "analyticId": "string",  // Identificador do analytic
  "filter": {},            // Expressão para montar um filtro seguindo o modelo de uma árvore binária
  "order": [               // 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)
    }
  ],
  "additionalFilter": {}
}
Tipos de funções padrões:

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

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms/actions/setPageAnalyticFilter" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "pageId": "string", "analyticId": "string", "filter": { }, "order": [ { "schema": "string", "table": "string", "column": "string", "function": "AVG", "order": "ASC" } ], "additionalFilter": { } }"

Responses:

200 OK

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 (Página não encontrada)
{
  "message": "Descrição do erro",
  "errorCode": "codigoDoErro",
  "reason": "OBJECT_NOT_FOUND",
  "domain": "platform",
  "service": "cms"
}

Este artigo foi útil para você?