API

Obter a lista de avaliações

GET/api/crm/v2/feedbackv2
operationId: feedback.default

Retorna uma lista de avaliações. Se download=yes, a seleção é retornada como um arquivo CSV.

Autorização

api-token + language + role

Parâmetros de consulta

date_fromstring

Exemplo: 25/04/2024

date_tostring

Exemplo: 26/04/2024

chain_idinteger

Exemplo: 1

branch_idinteger

Exemplo: 1

statusstring

Valores:positivenegative

Exemplo: positive

publishedinteger

Valores:01

Exemplo: 1

client_account_idinteger

Exemplo: 1

answerstring

Valores:waitingsend

Exemplo: send

downloadstring

Envie yes para baixar a amostra como um arquivo CSV

Valores:yes

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
date_fromobject (FilterSelect)
valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of object
valuestringobrigatório

Exemplo: example

namestringobrigatório

Exemplo: All

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 (FilterSelect)
valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of object
valuestringobrigatório

Exemplo: example

namestringobrigatório

Exemplo: All

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

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

statusobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string
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

publishedobject (FilterEnumInteger)

Filtro de enumeração com valores numéricos (boolean_select: published, contract_concluded)

valueinteger

Exemplo: 1

typestringobrigatório

Exemplo: select

optionarray of integer
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

client_account_idobject (FilterId)
valueany

Exemplo: 0

typestringobrigatório

Exemplo: integer

placeholderstring

Exemplo: integer

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

answerobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string
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

downloadobject (FilterButtonDownloadCsv)

Botão de download da seleção: ao clicar, envie download=yes

valuestring

Exemplo: Download

typestringobrigatório

Exemplo: button_download_csv

listarray of object
idintegerobrigatório

Exemplo: 1

statusstringobrigatório

Valores: positive, negative

Exemplo: positive

branch_idnumberobrigatório

Exemplo: 1

datestring (DataTimeFormatSQL) obrigatório

Exemplo: 2024-05-02 08:31:16

textstringobrigatório

Exemplo: everything was great

client_branch_profile_idnumber

Exemplo: 1

platformstring

Valores: ios, android, site, vk, api, fb

Exemplo: ios

answerstring

Exemplo: ok

publishedbooleanobrigatório

Exemplo: true

imagestring

Exemplo: https://cdn.foodsoul.dev/zones/ru/branches/8993/images/feedback/00d4bc187ec183b0be2c1aff784973a0.jpg?v1729080844

city_namestringobrigatório

Exemplo: London

chain_idnumberobrigatório

Exemplo: 1

branch_namestringobrigatório

Exemplo: Main

chain_namestringobrigatório

Exemplo: Green Basket

user_namestring

Exemplo: user name