Create audit with the SE Ranking API

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

Identifier
se_ranking_create_audit

The request

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>"
  }
}

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
domainstringYesDomain to audit, like example.com.
titlestringNoTitle of the audit report. The default is the domain.
settingsobjectNoCrawl settings to override; the ones left out keep their defaults.

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