Sign inStart free

Create API keys and use the visibility API

On Scale and Agency, read your visibility data from your own scripts and dashboards.

Open this page in the app

Steps

  1. Open Settings and find API keys. Keys are available on the Scale and Agency plans.

  2. Enter a Label, for example "reporting script", and press Create key.

  3. Copy the key straight away. It starts with sl_live_ and is shown only once.

  4. Call GET /api/v1/visibility with the header Authorization: Bearer followed by your key.

  5. Add ?domain=yourcompany.com to choose a business. Without it, you get your first business.

  6. To stop a key working, press Revoke next to it.

Tips

  • The response includes mention rate, cited rate, average position, and results by engine and by topic, plus share of voice, top sources, whether sample data is included, and the last run time.
  • The response also carries by_cluster, the old name for by_topic. Both return the same data. Use by_topic.
  • The limit is 120 requests a minute per key.
  • Store keys in a secret manager, never in front-end code. Revoke any key you think has leaked.

Still stuck? Email us

Write to hello@aiknowsus.com. Tell us the page you were on and what you expected to happen.

Email support