API
By arrangementRead your AI visibility figures from your own tools.
A read-only API gives your spreadsheet, dashboard or software the same figures you see in the workspace. Every rate comes with the counts behind it.
Example visibility, the share of counted answers naming each business.
Your workflow
- 01Make a key
- 02Find your question set
- 03Call the API
- 04Turn it off when done
01 / API
Use your figures elsewhere
The analytics API serves businesses that report in their own spreadsheet or dashboard. It returns the same figures the workspace shows, and nothing is recalculated on the way out.
The API only reads. Each key belongs to one workspace.
02 / API
What the API returns
For each question set you can read its prompts, visibility, citations and competitors for a window, each with its denominator. A prompt is a question put to an AI assistant.
A status endpoint reports where collection stands, and a runs endpoint pages through collection runs.
03 / API
Figures that carry their limits
Each rate arrives with its numerator and denominator. A period with no valid answer returns null rather than zero.
Different collection methods are different kinds of evidence, and the API never mixes methods in one figure.
04 / API
Make and turn off keys
An owner or an administrator makes keys on the Keys screen under Connections, and a recent sign-in is needed. A new key is shown once, and only a scrambled copy is kept.
Turning a key off takes effect at once. The API reference on this website is generated from the published OpenAPI document, so the two cannot disagree.
How it works
- Make a key An owner or administrator makes a read-only key on the Keys screen.
- Find your question set Note the ID of the question set you want to read.
- Call the API Send the key with each request and read the figures for a window.
- Turn it off when done Turn the key off when the tool no longer needs it.
Who it is for
Service businesses
Pull AI visibility into your monthly management pack, with the counts beside each rate.
Practices
Read each website's figures into one internal dashboard. Each key reads one workspace.
Shops
Set AI visibility beside your own sales data. The API supplies the visibility side only.
How Carqo works
You connect your website, review what AI search says and receive drafts for your next steps.
Carqo checks the facts
Facts are checked against their source where Carqo holds one. Conflicts and out-of-date facts are flagged to you.
Carqo shows where AI search mentions you
It follows your customer prompts and shows what the answers said about your business.
You decide what to do with each draft
A person on your side reviews each draft and decides whether to use it.
Common questions
Can the API change anything in my workspace?
No. Every key only reads. It cannot put a question to an AI assistant, change a question set or see another workspace.
What happens if a key leaks?
Turn it off on the Keys screen and it stops working at once. Then make a new key.
Why does a period return null instead of zero?
Null means no valid answer was collected for that period. Zero would claim that answers were collected and none named you.
Is there a rate limit?
Yes. Each key can make up to 120 requests a minute. A request over the limit is refused with a status and a sentence.
Can the API change anything in my workspace?
No. Every key only reads. It cannot put a question to an AI assistant, change a question set or see another workspace.
What happens if a key leaks?
Turn it off on the Keys screen and it stops working at once. Then make a new key.
Why does a period return null instead of zero?
Null means no valid answer was collected for that period. Zero would claim that answers were collected and none named you.
Is there a rate limit?
Yes. Each key can make up to 120 requests a minute. A request over the limit is refused with a status and a sentence.
See the answers.
Then choose your next step.
Start with a free AI visibility report.