Getting Started with the Metrics API
Last updated: October 6, 2026
The Metrics API gives you the same data you see in Rankscale, so you can pull it into your own reports, dashboards and tools. You can also use it to set up brands, topics and search terms automatically.
Is the API Included in your Plan?
The Metrics API is available on selected plans. See rankscale.ai/pricing for details.
What You Can Do with It
Area | What you can do |
|---|---|
Reporting | Get dashboard metrics, search term results, sentiment, citations, shopping and ads data for any brand |
Workspace management | Create and update brands, topics and search terms, start or pause search terms, and run a search term now |
Prompt research | Start a prompt research run and fetch its results |
Credits | Check your credit balance and how long your credits will last |
Create your API Key
Click your name at the bottom of the sidebar to open Settings.
Open the Integrations tab.
In the REST API (Metrics API) card, click Generate API Key.
Click the copy icon next to Your API Key and store the key somewhere safe.
The card now shows API Key Active, and your key is ready to use.
Keep your Key Secret
Anyone with your API key can read your data and change your workspace. Store it on a server, never in a website or app that others can open. If a key leaks, revoke it in the same card and generate a new one.
Who Can See What
An API key has the same permissions as the person who created it.
If you are a workspace member, your key only returns the brands you can see in Rankscale.
To change a brand, its topics or its search terms through the API, you need write access to that brand.
Tip: Agencies: to give a client API access to their brand only, invite them as a workspace member with access to that one brand, and let them create their own key.
Limits
Each API key can make up to 200 requests per minute. If you go over, wait a moment and try again.
Full Documentation
Every endpoint, with examples, is in Integration Docs in the account menu at the bottom of the sidebar. You can also reach it from the setup guide link in the REST API (Metrics API) card.
Related Articles
📄 Managing Share Links via the API