Analytics
Mention in your product and your AI agents, through one API
The Mention toolkit covers the account and its reference lists, alerts, the mentions they collect, and tags. Through Connect your product or AI agent calls them with one endpoint, while Connect stores the API token and logs every execution.
15 days to try it. No credit card.
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": []
}
}How it works
From a connected customer to the first Mention call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Mention account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with Mention.
Set up brand monitoring
A reputation tool creates an alert with a query, languages and sources for a new customer, then refines the query later.
Feed mentions into a dashboard
A SaaS lists the mentions an alert collected, with source, language and tone, and pages back to older ones.
Agent that curates mentions
An AI agent marks mentions as read or favorite, sets the tone, moves them to a folder and tags them.
Tools
10 Mention tools
- Get accountGETReturns the Mention account of the connection with its id, name, email and language. The id is the account_id that the other tools take.
- Get app dataGETReturns the reference lists of Mention: alert_languages, alert_countries and alert_sources, whose keys are the codes that alerts and mention filters take, plus alert_tones and mention_folders.
- List alertsGETLists the alerts of the account with id, name, query, languages, sources and mention counts per folder. When there are more alerts, the response has _links.more with the cursor of the next page.
- Create alertPOSTCreates an alert, which starts collecting the mentions that match its query, and returns it with its id. Collected mentions count against the quota of the Mention plan.
- Update alertPUTUpdates an alert, usually to refine its query, and returns it. Only the fields sent change. A query sent replaces the current one and needs its type.
- List mentionsGETLists the mentions an alert collected, with title, text, URL, source, language, tone and folder. The response has _links.more, whose href carries the cursor of the older mentions. Some filters cannot be combined, as each one says.
- Get mentionGETReturns one mention with title, text, URLs, source, language, tone, folder, the read and favorite flags, its tasks and the first page of its child mentions.
- Update mentionPUTCurates a mention: marks it read or favorite, moves it to a folder, sets its tone or tags it, and returns it. Only the fields sent change. The content of a mention never changes.
- List tagsGETLists the tags of an alert with id, name, mention count and auto-tagging keywords. The id is what the tags of Update mention take.
- Create tagPOSTCreates a tag in an alert and returns it with its id. An alert holds up to 100 tags, and new mentions that contain one of the keywords are tagged automatically.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
Questions about the Mention toolkit
Do I need to build against the Mention API?
No. Connect ships 10 Mention tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their Mention account?
With the mode the toolkit accepts: API key. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
