Gumshoe has an API. The API lets you connect your Visibility Audit data and insights directly to your workflows and systems. Using the API makes it easier to integrate Gumshoe into dashboards and combine your AI visibility data with the rest of your tech stack.
You may also be interested in our JSON export, which returns the same Visibility Audit data without using the API. See the article How Do I Export a Gumshoe Visibility Audit to JSON, PDF, or CSV?
Do I have access to the API?
Gumshoe must enable API access first. If you're on a paid Pro plan, ask for a human over chat or email support@gumshoe.ai, and we'll turn it on for your account.
What can I do with the API right now?
The API is currently read-only. You can pull your Visibility Audit data and insights out of Gumshoe, but you can't create a new Visibility Audit through the API yet.
How do I find my API key?
- Click the dropdown in the top-left corner of your screen.
- Next to your workspace name, click the small settings icon to open Workspace Settings.
- In the left-side menu, scroll to "Manage workspace" and select API Keys.
If you don't see it listed:
- API access may not be enabled for your account yet. Ask for a human over chat or email support@gumshoe.ai to request it.
- You may be in the wrong workspace.
- You may have limited access to the workspace you are in.
If you still don't see it after checking these, ask for a human over chat or email our team at support@gumshoe.ai. We'll investigate.
Where is the API documentation?
You can open the API documentation from the API Keys page or by clicking here.
How do I fix a 401 error when using the API?
A common cause of a 401 error on the runs endpoint is passing the run's ID in the {ordinal} placeholder. That field expects the run's ordinal number (1, 2, 3, etc., based on run order), not the runId.
You may also be interested in our JSON export, which returns the same Visibility Audit data without using the API. Read more here.