Créer une alerte avec l'API Mention

Crée une alerte, qui commence à collecter les mentions correspondant à sa requête, et la renvoie avec son id. Les mentions collectées comptent dans le quota du forfait Mention.

Identifiant
mention_create_alert

L'appel

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": []
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
account_idstringOuiId of the account, from Get account.
namestringOuiName of the alert.
queryobjectOuiWhat 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.
languagesarrayOuiCodes 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.
countriesarrayNonCodes 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.
sourcesarrayNonCodes of the sources to track, such as web, news, blogs, forums, videos, twitter or facebook, from the alert_sources of Get app data.
blocked_sitesarrayNonURLs whose mentions are ignored. A URL also blocks the pages under it.
noise_detectionbooleanNontrue skips new mentions similar to the ones put in spam or trash.
reviews_pagesarrayNonURLs of review pages on Tripadvisor, Yelp or Booking to monitor.

Connexions possibles

Votre client connecte son compte Mention une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/mention_create_alert. Il devient la définition de tool de votre agent sans conversion.

Autres tools Mention

Voir les 10 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.