- Eventos de mudança vão para o seu
webhookUrlquando as respostas a um prompt mudam: sua marca aparece ou desaparece, um concorrente passa à frente ou um site é citado pela primeira vez. - Alertas enviam um e-mail aos administradores da sua conta quando a taxa de menção da marca nos últimos sete dias cai
abaixo de
alertBelowPct.
Eventos de mudança
DefinawebhookUrl ao criar ou atualizar um monitor:
400 VALIDATION_ERROR. webhookUrl: null
desliga os eventos e descarta o estado de eventos do monitor; ligá-los de novo parte do histórico dele.
Tipos de evento
Os eventos de marca acompanham cada prompt separadamente em cada mecanismo e, em um monitor de grade, em cada ponto. O estado
é lido das últimas cinco respostas, então
samples: 5 gera um estado completo em uma execução.
- Um evento é enviado uma vez, quando o estado muda. Uma marca que continua fora das respostas envia um
monitor.mention.stoppede nada mais até voltar. - Um prompt passa a ter estado quando reúne cinco respostas. Esse primeiro estado é a referência e não envia nada.
- Um monitor de categoria não tem marca própria e envia só
monitor.source.first_cited.
- Ao ligar
webhookUrlem um monitor que já tem respostas: o estado de cada prompt é reconstruído a partir das últimas cinco respostas dos últimos 30 dias, e todo domínio já citado conta como conhecido. Os eventos começam com a próxima resposta. - Ao criar um monitor com
webhookUrl, ou ligá-lo antes de existir qualquer resposta: a primeira execução define os domínios conhecidos, emonitor.source.first_citedconta respostas de tarefas criadas depois que essa execução foi totalmente enviada. Os eventos de marca começam quando um prompt reúne cinco respostas.
Payload
Cada evento é umPOST com corpo JSON. Por exemplo:
Assinatura e novas tentativas
Os eventos são assinados e tentados de novo como os webhooks de tarefa: os mesmos três cabeçalhosquerying-webhook-*, o mesmo
esquema HMAC-SHA256 e o mesmo cronograma de novas tentativas. Verifique-os com o código de
Webhooks. Duas coisas mudam:
querying-webhook-idé oiddo evento. Deduplique por ele.- A chave HMAC é o digest SHA-256 da chave de API que definiu
webhookUrl, não da chave de uma tarefa.
webhookUrl de novo com a chave nova, e os eventos passam a ser assinados com ela. Se
a chave que definiu webhookUrl for revogada ou expirar, os eventos param: cada um é marcado como failed com o
motivo em delivery.lastError, e nada é enviado sem assinatura.
Liste e reenvie eventos
GET /v1/monitors/{id}/events (referência) lista os eventos do mais novo para o mais antigo.
A resposta tem
webhookUrl, nextCursor (null na última página) e events. Cada evento tem id,
type, createdAt, data (como no payload) e delivery:
POST /v1/monitors/{id}/events/{eventId}/redeliver
(referência) reenvia agora um evento para o
webhookUrl atual, com uma nova série de tentativas, e retorna o evento com o delivery atualizado. Eventos já entregues
também podem ser reenviados. Retorna 409 WEBHOOK_NOT_SET quando o monitor não tem webhookUrl e
404 NOT_FOUND para um evento desconhecido.
Os eventos ficam guardados por 30 dias. Um evento ainda em novas tentativas é guardado até elas terminarem.
Alertas
DefinaalertBelowPct em um monitor de marca, uma porcentagem inteira de 1 a 100, para receber um e-mail quando a
taxa de menção da marca cair abaixo dele:
- Janela: as respostas pontuadas dos últimos 7 dias, em todos os prompts e mecanismos do monitor. O relatório usa 30 dias por padrão, o que muda devagar demais para avisar alguém.
- Quando: cada vez que uma execução agendada começa. A verificação lê as respostas já pontuadas, então reflete as execuções anteriores.
- Amostra mínima: menos de 5 respostas pontuadas na janela nunca disparam. Um monitor novo, ou um cujos mecanismos estão falhando, fica em silêncio.
- Cruzamento, não estado: o alerta dispara quando a taxa está abaixo do limite e o alerta está armado,
e então se desarma. Ele se rearma quando a taxa volta a ficar igual ou acima do limite, então um monitor que continua baixo
envia um e-mail, não um por execução. Mudar
alertBelowPcto rearma.
alertBelowPct com 400 VALIDATION_ERROR.
alertBelowPct: null desliga o alerta.
Histórico de alertas
GET /v1/monitors/{id}/alerts (referência) retorna
alertBelowPct, armed e deliveries: os 20 e-mails de alerta mais recentes do monitor, incluindo
os de teste. Cada envio tem id, status (pending, sent ou failed), attempts, createdAt,
sentAt, lastError e payload (monitorId, name, ratePct, threshold, windowDays, runs).
Os registros de envio ficam guardados por 90 dias.
Envie um alerta de teste
POST /v1/monitors/{id}/alerts/test (referência) enfileira um e-mail de teste
pelo mesmo caminho de entrega de um alerta real, com “(test)” depois do nome do monitor, e retorna
data.queued: true. Confira o resultado no histórico de alertas. Você pode enviar três e-mails de teste por monitor
a cada cinco minutos; acima disso, a resposta é 429 RATE_LIMITED. Um monitor de categoria retorna 400 VALIDATION_ERROR.
Próximos passos
Webhooks
Assinatura, novas tentativas e handlers seguros para todos os webhooks.
Fontes e respostas
Abra a resposta por trás de um evento.