API

Obter análise de feedback

GET/api/crm/v2/feedback_analyticsv2
operationId: feedbackAnalytics.default

Retorna painéis resumidos e um gráfico de feedbacks para o período especificado. Cada ponto representa uma hora em UTC; apenas pontos não vazios são retornados. A interface converte o horário para o fuso horário do usuário e agrupa as horas em dias. O período padrão é hoje. O período é limitado a um ano; períodos mais longos são cortados a partir das datas mais recentes. O painel de participação contém dynamics — a variação em relação a date_comparison_*. Se esse período não for especificado, por padrão é utilizado um período de mesma duração imediatamente anterior ao selecionado. Esse valor padrão é aplicado apenas para comparação e não é retornado nos filtros.

Autorização

api-token + language + role

Parâmetros de consulta

date_fromstring

Exemplo: 25/04/2024

date_tostring

Exemplo: 26/04/2024

date_comparison_fromstring

Exemplo: 25/03/2024

date_comparison_tostring

Exemplo: 26/03/2024

chain_idinteger

Exemplo: 1

branch_idinteger

Exemplo: 1

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_toobject (FilterDateTo)
valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_rangeobject (FilterDateRange)

Períodos prontos para filtro de data; o limite inferior é calculado no fuso horário do usuário. value — período correspondente aos atuais *_from e *_to; null — período personalizado. default — período que o servidor insere na requisição sem datas: também é aplicado no primeiro carregamento da seção e ao redefinir o filtro. O limite superior do período é sempre igual ao dia atual do usuário, por isso option não o inclui: não é necessário enviar *_to para um período pronto, o servidor define automaticamente. Períodos com duração superior a um ano são cortados no limite mais recente.

valuestring (DateRange) pode ser nulo

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

defaultstring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

typestringobrigatório

Exemplo: select

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

optionarray of objectobrigatório
valuestring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

date_fromstringobrigatório

Exemplo: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_comparison_toobject (FilterDateTo)
valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Períodos prontos para filtro de datas sem valor padrão: default é sempre igual a null.

valuestring (DateRange) pode ser nulo

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

defaultstring (DateRange) pode ser nulo

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

typestringobrigatório

Exemplo: select

optionarray of objectobrigatório
valuestring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

date_fromstringobrigatório

Exemplo: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

tilesobject
totalobject (FeedbackAnalyticsCountTile) obrigatório

Bloco contador na linha de resumo: número de avaliações e sua porcentagem no período. percent é null se não houver avaliações no período. A variação em relação ao período de comparação não é fornecida intencionalmente: o número de avaliações depende do tráfego, portanto, seu aumento não indica qualidade.

valueintegerobrigatório

Exemplo: 96

percentnumber · float

Exemplo: 75

positiveobject (FeedbackAnalyticsCountTile) obrigatório

Bloco contador na linha de resumo: número de avaliações e sua porcentagem no período. percent é null se não houver avaliações no período. A variação em relação ao período de comparação não é fornecida intencionalmente: o número de avaliações depende do tráfego, portanto, seu aumento não indica qualidade.

valueintegerobrigatório

Exemplo: 96

percentnumber · float

Exemplo: 75

negativeobject (FeedbackAnalyticsCountTile) obrigatório

Bloco contador na linha de resumo: número de avaliações e sua porcentagem no período. percent é null se não houver avaliações no período. A variação em relação ao período de comparação não é fornecida intencionalmente: o número de avaliações depende do tráfego, portanto, seu aumento não indica qualidade.

valueintegerobrigatório

Exemplo: 96

percentnumber · float

Exemplo: 75

positive_shareobject (FeedbackAnalyticsShareTile) obrigatório

Bloco de participação na linha de resumo. Diferente dos contadores, contém dynamics — alteração da participação em relação ao período de comparação em pontos percentuais; não depende do tráfego. percent e dynamics são null se não houver base para o cálculo: não há avaliações no período ou no período de comparação.

valueintegerobrigatório

Exemplo: 96

percentnumber · float

Exemplo: 75

dynamicsnumber · float

Exemplo: -0.2

pointsarray of object
datetimestringobrigatório

Início do ponto horário em UTC

Exemplo: 2026-09-08 10:00:00

positiveintegerobrigatório

Exemplo: 3

negativeintegerobrigatório

Exemplo: 1