Criar alerta no Mention, por uma API
Cria um alerta, que começa a coletar as menções que correspondem à sua consulta, e o retorna com seu id. As menções coletadas contam na cota do plano do Mention.
- Identificador
- mention_create_alert
A chamada
POST https://connect.reportei.com/api/tools/mention_create_alert/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"account_id": "<account_id>",
"name": "<name>",
"query": {},
"languages": []
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| account_id | string | Sim | Id of the account, from Get account. |
| name | string | Sim | Name of the alert. |
| query | object | Sim | What the alert tracks. A basic query takes included_keywords, required_keywords, excluded_keywords and monitored_website, with at least one keyword in included_keywords or required_keywords. An advanced query takes query_string instead. |
| languages | array | Sim | Codes of up to 5 languages to track, such as en or pt, from the alert_languages of Get app data. In an advanced query they apply only to monitored pages and reviews pages. |
| countries | array | Não | Codes of up to 5 countries to track, such as US or BR, from the alert_countries of Get app data. XX keeps the mentions without a country. Omit it to track every country. Ignored in an advanced query. |
| sources | array | Não | Codes of the sources to track, such as web, news, blogs, forums, videos, twitter or facebook, from the alert_sources of Get app data. |
| blocked_sites | array | Não | URLs whose mentions are ignored. A URL also blocks the pages under it. |
| noise_detection | boolean | Não | true skips new mentions similar to the ones put in spam or trash. |
| reviews_pages | array | Não | URLs of review pages on Tripadvisor, Yelp or Booking to monitor. |
Conexões possíveis
O seu cliente conecta a conta do Mention uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/mention_create_alert. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Mention
- Obter contaGETRetorna a conta Mention da conexão com id, nome, e-mail e idioma. O id é o account_id que as outras ferramentas pedem.
- Obter dados do appGETRetorna as listas de referência do Mention: alert_languages, alert_countries e alert_sources, cujas chaves são os códigos que alertas e filtros de menções aceitam, além de alert_tones e mention_folders.
- Listar alertasGETLista os alertas da conta com id, nome, consulta, idiomas, fontes e contagem de menções por pasta. Quando há mais alertas, a resposta traz _links.more com o cursor da próxima página.
- Atualizar alertaPUTAtualiza um alerta, em geral para refinar sua consulta, e o retorna. Só os campos enviados mudam. Uma consulta enviada substitui a atual e exige seu type.
- Listar mençõesGETLista as menções que um alerta coletou, com título, texto, URL, fonte, idioma, tom e pasta. A resposta traz _links.more, cujo href leva o cursor das menções mais antigas. Alguns filtros não podem ser combinados, como cada um indica.
- Obter mençãoGETRetorna uma menção com título, texto, URLs, fonte, idioma, tom, pasta, as flags de lida e favorita, suas tarefas e a primeira página de suas menções filhas.
- Atualizar mençãoPUTOrganiza uma menção: marca como lida ou favorita, move para uma pasta, define o tom ou aplica tags, e a retorna. Só os campos enviados mudam. O conteúdo de uma menção nunca muda.
- Listar tagsGETLista as tags de um alerta com id, nome, contagem de menções e palavras-chave de marcação automática. O id é o que as tags de Atualizar menção aceitam.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
