Obter análise de promoções
/api/crm/v2/special_offers_analyticsv2specialOffersAnalytics.defaultAutorização
api-token + language + role
Parâmetros de consulta
Exemplo: 25/04/2024
Exemplo: 26/04/2024
Exemplo: SALE20
Exemplo: percent_discount_on_all_order
Exemplo: 152410
Plataforma de pedido
Valores:androidapifbiosvksite
Status do pedido: em trânsito, concluído, em montagem, na cozinha, não processado, pronto para envio, aguardando envio para a cozinha, aguardando refação, cancelado, confirmado, preparado
Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked
Exemplo: confirmed
Status do pagamento: não pago, pendente, pago
Valores:not_paidwaitingpaid
Método de entrega: courier ou retirada
Valores:courierpickup
Respostas
OK
Valores:successerror
Exemplo: success
Exemplo: 2026-08-01 00:00:00
Exemplo: date
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
Exemplo: 2026-08-31 23:59:59
Exemplo: date
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
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.
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
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
Exemplo: select
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
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
Exemplo: 25/08/2026
Exemplo: 8920
Exemplo: select
Exemplo: 8920
Exemplo: Green Basket | Kaliningrad
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
Exemplo: 8920
Exemplo: select
Exemplo: 8920
Exemplo: Green Basket | Kaliningrad
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
Exemplo: example
Exemplo: integer or string
Exemplo: string
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
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
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
Exemplo: 8920
Exemplo: select
Exemplo: 8920
Exemplo: Green Basket | Kaliningrad
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
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
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
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
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
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
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
Filtro de enumeração — lista plana de valores de enum
Exemplo: example
Exemplo: select
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
Exemplo: 412
Exemplo: 531420.5
Exemplo: 1289.86
Pedidos que atingiram o status done ou confirmed
Exemplo: 379
Percentual de pedidos concluídos dentro desta metade
Exemplo: 91.99
Percentual de todos os pedidos no período
Exemplo: 34.2
Exemplo: 29.7
O que significa metade. Se um código promocional, tipo de promoção ou promoção específica for selecionado, a primeira metade é reduzida e o par se torna matched_filter e rest; o denominador em qualquer caso são todos os pedidos do período. Defina a metade pelo key, e não pela posição.
Valores:with_promo_codewithout_promo_codematched_filterrest
Exemplo: with_promo_code
Exemplo: 412
Exemplo: 531420.5
Exemplo: 1289.86
Pedidos que atingiram o status done ou confirmed
Exemplo: 379
Percentual de pedidos concluídos dentro desta metade
Exemplo: 91.99
Percentual de todos os pedidos no período
Exemplo: 34.2
Exemplo: 29.7
Primeira metade menos a segunda, em valores absolutos; as proporções são subtraídas em pontos percentuais
Exemplo: -284
Exemplo: -412300.1
Exemplo: 180.4
Exemplo: -3.11