Get ranking history with the SE Ranking API
Returns 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.
- Identifier
- se_ranking_get_ranking_history
The request
POST https://connect.reportei.com/api/tools/se_ranking_get_ranking_history/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"site_id": 1
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | integer | Yes | Id of the project, from List projects. |
| type | string | No | Metric of the series. The default is avg_pos, the average position.Values: avg_pos, visibility, visibility_percent, top10, top10_percent |
| site_engine_id | integer | No | Only this search engine of the project, from List project search engines, without the average series. |
| date_from | string | No | First day of the period, as YYYY-MM-DD. The default is one week ago. |
| date_to | string | No | Last day of the period, as YYYY-MM-DD. The default is today. |
Supported connections
Your customer connects their SE Ranking account once, with one of the modes below. The same connection serves every tool of the toolkit.
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.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/se_ranking_get_ranking_history. It becomes your agent's tool definition with no conversion.
Other 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.
- 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.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
