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

ParameterTypeRequiredDescription
site_idintegerYesId of the project, from List projects.
typestringNoMetric of the series. The default is avg_pos, the average position.Values: avg_pos, visibility, visibility_percent, top10, top10_percent
site_engine_idintegerNoOnly this search engine of the project, from List project search engines, without the average series.
date_fromstringNoFirst day of the period, as YYYY-MM-DD. The default is one week ago.
date_tostringNoLast 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.