API overview
Rank Snapshot
rank-snapshot
Capture a focused ranking picture for priority queries and pages.
Pricing & runtime
- Current price
- 11 Credits per run
- Timeout
- up to 600s
- 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 | DomainBare hostname only, for example example.com. |
| keywords | long_text | Optional | KeywordsEnter one keyword per line, or separate items with commas. |
| ai_queries | long_text | Optional | AI queriesEnter one AI query per line, or separate items with commas. |
| market | short_text | Optional | MarketCountry or region for search data. Use an English country name. |
| language | short_text | Optional | LanguageSearch language for ranking data. |
| previous_snapshot | long_text | Optional | Previous snapshot JSONOptional. Paste the data payload of a previous rank-snapshot run to get a diff. |
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": "rank-snapshot",
"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).