SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

How often AI model answers name and cite your website.

Mention, citation and recommendation rates over the window, share of voice against your tracked competitors, a day by day trend, results per model, questions where competitors are cited and you are not, which AI crawlers your robots.txt lets in, and AI assistant visits when they are measured. Rates are fractions from 0 to 1, or null when nothing was observed. Every number is an observation of what a named AI model said when asked a question on a date. It is never a ranking inside an AI product, and it does not prove that an AI product used a page. Spends no SoftSolz AI credits.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/ai-visibility

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

daysinteger

How many days back to look, 1 to 365 (default 30).

Response

Response Body

summaryobjectTotals for the window.
trendarray of objectsOne row per day with answers.
by_modelarray of objectsResults per model.
competitorsarray of objectsYour tracked competitors, measured the same way.
citation_opportunitiesarray of objectsPages worth making easier to cite.
ai_crawler_accessobjectrobots.txt verdict per AI crawler, or null before the first read.
ai_referralsobjectVisits from AI assistants when Website Analytics or Blogs measure them.
settingsobjectThe scheduled check settings for the website.
last_checked_atstring | nullWhen SoftSolz last checked.
next_check_atstring | nullWhen the next scheduled check is due.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/ai-visibility \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"summary": {
"checks": 24,
"questions_checked": 8,
"mention_rate": 0.42,
"citation_rate": 0.25,
"recommendation_rate": 0.17,
"share_of_voice": [
{
"name": "Acme Bakery",
"kind": "own",
"competitor_id": null,
"mentions": 10,
"share": 0.56
}
],
"sources": {
"softsolz_check": 18,
"external_app": 6,
"manual": 0
}
},
"trend": [
{
"day": "2026-10-01",
"mention_rate": 0.5,
"citation_rate": 0.25,
"checks": 4
}
],
"by_model": [
{
"provider": "openai",
"model_id": "gpt-4o",
"checks": 12,
"mention_rate": 0.5,
"citation_rate": 0.33
}
],
"competitors": [
{}
],
"citation_opportunities": [
{
"question_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"question": "Where can I buy sourdough in Leeds?",
"competitor_domains": [
"breadco.com"
],
"own_page_url": "https://acmebakery.co.uk/sourdough"
}
],
"ai_crawler_access": {},
"ai_referrals": {
"measured": false,
"source": null,
"visits_30d": null,
"previous_30d": null
},
"settings": {
"enabled": false,
"frequency": "monthly",
"models": [],
"mode": "web_search"
},
"last_checked_at": null,
"next_check_at": null
}
}