Skip to content
API & webhooks

Your AI visibility data, anywhere.

A REST API for brands, daily scores, analysed answers, prompts and recommendations — and signed webhooks that fire when a run completes, an alert is raised or a new plan is written.

Terminal
$ curl https://mentioned.app/api/v1/projects/{id}/metrics \
    -H "Authorization: Bearer mk_live_…"

{
  "data": [
    { "day": "2026-11-06", "provider": "all",
      "visibility_score": 58.4, "score_margin": 5.1,
      "mention_rate": 0.66, "share_of_voice": { "Northwind": 0.41, … } }
  ]
}

Example data · fictional brands

Included on

  • Starter (not included)
  • Growth (included)
  • Agency (included)

Included on Growth, Agency.

[01]What you get

API & webhooks, in detail.

A REST API for scores, answers and prompts, plus signed webhooks when runs finish or alerts fire.

01

REST API v1

Brands, daily metrics per engine, every analysed answer, prompts and recommendations.

02

Add prompts programmatically

Create prompts via the API — useful for syncing from your keyword or content tools.

03

Scoped API keys

Bearer keys per workspace, stored hashed and shown once. Revoke any time.

04

Fair rate limits

600 requests per hour per key, with a consistent error envelope.

05

Signed webhooks

run.completed, alert.created and recommendations.created — HMAC-signed with a timestamp.

06

Retries built in

Failed deliveries are retried with backoff; endpoints that keep failing are paused.

[02]How it works

A closer look, step by step.

01 · Endpoints

Everything in the dashboard, as JSON.

Pull scores into your warehouse, put share of voice on a company dashboard, or build your own reports on top of the analysed answers.

  • Paginated, predictable responses
  • Workspace-scoped keys
  • Documented error codes
REST API · v1
GET/api/v1/projects
GET/api/v1/projects/{id}
GET/api/v1/projects/{id}/metrics
GET/api/v1/projects/{id}/results
GET · POST/api/v1/projects/{id}/prompts
GET/api/v1/projects/{id}/recommendations

Bearer API keys · 600 requests per hour per key

Example data · fictional brands

02 · Webhooks

React the moment something happens.

Point a webhook at your own service to trigger workflows when a run finishes, an alert fires or a new weekly plan is ready. Every delivery is signed so you can verify it came from us.

  • mentioned-signature: t=…, v1=…
  • Reject anything older than 5 minutes
  • Test pings from settings
Webhook · POST
POST https://hooks.yourapp.example/mentioned
content-type: application/json
mentioned-signature: t=1762419600,v1=5f2c…a91e

{ "type": "alert.created",
  "data": { "severity": "warning",
    "title": "Kestrel now gets mentioned more than you" } }

Example data · fictional brands

03 · No code

Or just connect Slack.

Don’t need a pipeline? Connect a Slack incoming webhook and warnings and critical alerts post straight to your channel.

  • Two-minute setup
  • Links back to the dashboard
  • Available on paid plans
Slack · #marketing· Example
m

Mentioned APP 9:02 AM

Northwind: Visibility dropped 12.4 points

Northwind’s AI visibility score fell from 61 to 49 since Oct 30.

Open dashboard

Warnings and critical alerts post to Slack; everything goes to webhooks

Example data · fictional brands

[03]Where it fits

One part of the loop.

The API and webhooks put Mentioned’s data wherever your team already reports and automates — BI, warehouses, internal tools.

  1. 01

    Learn

    Brand Brain and keyword research: what you sell and what buyers search.

  2. 02

    Create

    A 30-day plan, written into fact-checked articles and carousels.

  3. 03

    Publish

    Your CMS on schedule, plus Reddit and Quora drafts.

  4. 04

    Fix

    Technical SEO fixes and AI-visibility fix plans.

  5. 05

    Track

    Rankings estimates and four AI engines, every week.

  6. 06· Here

    Report

    Growth against your day-0 baseline, for you or your clients.

See the whole loop on the product tour.

[04]FAQ

Good questions.

More detail in the methodology and API docs.

Which plans include the API?

Growth, Agency. Slack alerts are available on every paid plan.

How are webhooks signed?

Each delivery carries a mentioned-signature header with a timestamp and an HMAC-SHA256 of the timestamp and body, using your endpoint’s secret. Reject signatures older than five minutes.

What are the rate limits?

600 requests per hour per API key. Errors use a consistent JSON envelope with a code and message.

[05]Related

Works well with.

Free AI audit

See what AI says about you.

Enter your website. We’ll ask real buyer questions on two engines and show where you appear, who appears instead, and what to fix first.

Your website

Free · 5 buyer questions · 2 AI engines · no signup to see your score

  1. 01Where you appear across AI answers
  2. 02Who AI recommends instead of you
  3. 03Every answer, with the sources cited

Free · results in about a minute · or start a 3-day trial