API overview
SEO Patrol
seo-patrol
Patrol search health: ranking diffs with drop diagnosis and rescue steps, page audits, AI-citation checks, and an authority program.
Pricing & runtime
- Current price
- 25 Credits per run
- Timeout
- up to 2400s
- Brand Context
- Optional — pass a brand_context_id
Prices are calibrated against real run costs and may change — the credit_cost returned when creating a run is authoritative.
Input parameters
Pass these under the input object of POST /api/v1/runs.
| Key | Type | Required | Label & description |
|---|---|---|---|
| domain | short_text | Required | DomainThe site to patrol. |
| mode | select | Optional | ModeWeights the report.Options: Daily patrol, Keyword diagnosis, Authority program |
| keywords | long_text | Optional | Patrol keywordsOne per line; empty = brand + homepage terms. |
| ai_queries | long_text | Optional | AI citation queriesFixed queries to check citations for; empty = derived from top keywords. |
| llms_txt_url | short_text | Optional | llms.txt URLEmpty = check /llms.txt on the domain. |
| backlink_goals | long_text | Optional | Backlink goalsChannel × count targets for the authority program. |
| manual_metrics | long_text | Optional | Manual metricsNumbers you collected from platform dashboards or last patrol. |
| interaction_language | select | Optional | Report languageControls the language of the generated report.Options: English, Chinese |
Request example
Covers every required field. Optional fields follow the same pattern.
curl -X POST https://api.TODO-APP-DOMAIN/api/v1/runs \
-H "Authorization: Bearer $SUPAMARKETERS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"app_slug": "seo-patrol",
"input": {
"domain": "example text"
}
}'What you get back
A 201 response returns run_no, credit_cost, stream_url and result_url (relative paths). Stream progress from stream_url and fetch the terminal result — summary and output — from result_url. Results stay available for the App's retention window (30 days by default).