Read AI visibility
readScorecardHow often AI engines mention this brand, per engine and over time: series has a point per engine and per day, week or month (interval). byCountry splits the period by the country the engines are asked from; country keeps one. For what the engines actually said, readAnswers.
Only for a workspace that tracks its AI visibility (it has tracked prompts).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day of the range, YYYY-MM-DD, today at the latest; a range is two years at most | |
| days | No | Reporting window in days | |
| from | No | First day of a custom range, YYYY-MM-DD. With `to`, it takes the place of `days` | |
| scope | No | Unbranded prompts are the ones where a mention means the engine CHOSE to bring the brand up - the honest measure | unbranded |
| country | No | Only prompts asked from this country, as a two-letter code (a prompt's persona sets where it is asked from) | |
| interval | No | How far apart the points of `series` are; left out: daily up to 30 days, weekly up to 90 days, monthly beyond | |
| workspaceId | No | The workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | Yes | ||
| series | Yes | One point per period and engine, oldest first: engines are checked on different days | |
| totals | Yes | The whole period, every engine | |
| branded | Yes | How the engines answer prompts that name the brand, whatever `scope` is | |
| country | Yes | The country the figures are kept to; null for every country | |
| byEngine | Yes | ||
| interval | Yes | How far apart the points of `series` are | |
| byCountry | Yes | The period in each country the engines are asked from, most answers first; every country, whatever `country` is | |
| sentiment | Yes | How the answers that name the brand speak of it | |
| promptCounts | Yes | Active tracked prompts | |
| untrackedBrands | Yes | Brands the answers name that are not tracked competitors | |
| verifiedSamples | Yes | Answers read by the check that confirms which brand is meant | |
| lowSampleEngines | Yes | Engines with too few answers in the period to rely on |