List audits with the SE Ranking API

Lists 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.

Identifier
se_ranking_list_audits

The request

POST https://connect.reportei.com/api/tools/se_ranking_list_audits/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "search": "<search>"
  }
}

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
searchstringNoOnly the audits whose title or URL match this text.
date_startstringNoOnly audits from this day on, as YYYY-MM-DD.
date_endstringNoOnly audits up to this day, as YYYY-MM-DD.
limitintegerNoAudits per page. The default is 100.
offsetintegerNoHow many audits to skip, for the next pages.

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_list_audits. 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.