Analytics
SE Ranking in your product and your AI agents, through one API
The SE Ranking toolkit covers projects, the search engines and keywords they track, keyword positions and ranking history, competitors, website audits and backlink stats. Through Connect your product or AI agent calls them with one endpoint, while Connect stores the API key and logs every execution.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/se_ranking_create_audit/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"domain": "<domain>"
}
}How it works
From a connected customer to the first SE Ranking call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their SE Ranking account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with SE Ranking.
White-label SEO reports
An agency tool reads a project's summary, keyword positions and ranking history to build a client report.
Compare with competitors
A SaaS lists a project's competitors and gets their positions for the same keywords over a period.
Run and read site audits
An AI agent starts an audit of a domain and later reads its report, with the health score and the errors, warnings and notices.
Tools
12 SE Ranking tools
- List projectsGETLists the projects of the account, each a tracked website, with the id that the other tools ask for as site_id, its title, URL, keyword_count, check frequency and the guest_link to share the rankings without signing in.
- Get project summaryGETReturns the summary of a project: the average position of the last two checks, how many positions went up and down, keywords in the top 5, 10 and 30, visibility, Domain Authority and pages indexed in Google.
- List project search enginesGETLists the search engines a project tracks, each with the site_engine_id that the ranking tools take, its region, language and keyword_count.
- List keywordsGETLists the keywords a project tracks, with id, name (the keyword text), target link, group and the site_engine_ids it is tracked in. The ranking tools return only the keyword id, so this is where the text comes from.
- Get keyword positionsGETReturns the positions of the keywords of a project on each check date of a period, grouped by search engine, with the change, search volume and competition of each keyword. Keywords come by id: the text is in List keywords.
- Get ranking historyGETReturns a time series of one ranking metric of a project per check date: one series per search engine and one with the average of all of them. value comes sometimes as text and sometimes as a number.
- List competitorsGETLists the competitors added to a project, with the id that Get competitor positions asks for, their name, URL and Domain Trust.
- Get competitor positionsGETReturns the positions of a competitor for the keywords of the project on each check date of a period, grouped by search engine, with the keyword name and search volume.
- List auditsGETLists the website audits of the account, with id, url, title, status (like processing or finished), last_update and the latest stats, and total as the number found. The last page is when offset plus limit reaches total.
- Create auditPOSTStarts a website audit of a domain and returns its id; Get audit report shows is_finished when it ends. It uses the audit limits of the plan, and by default SE Ranking e-mails the report to the account owner at the end, unless settings.send_report is 0.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
Questions about the SE Ranking toolkit
Do I need to build against the SE Ranking API?
No. Connect ships 12 SE Ranking tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their SE Ranking account?
With the mode the toolkit accepts: API key. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
