guarded

Start scan

Start a creator scan for an app (spends scan credits). Same gates as the dashboard: active subscription required, and a queued/running scan for the app refuses with scan_in_progress. Guarded: without approval_token it returns {error:"approval_required", approval_token, summary} for the user to confirm; call again with the token. Every dashboard guardrail still applies: this is exactly what a user clicking the dashboard could do, no more. GUARDED: requires the account's Unrestricted MCP setting; returns 403 {error:'restricted'} otherwise.

post/api/v1/tools/start_scan

Request

  • Base URL: https://www.affiliatespy.io
  • URL: https://www.affiliatespy.io/api/v1/tools/start_scan
  • Auth: HTTP bearer

Request body

app_idstring uuid required

An app id from list_apps.

type'quick' | 'full' required

quick = fast pass; full = complete scan.

approval_tokenstring

Approval token from a previous approval_required response, after the user said yes.

Response

The tool's JSON result (same payload the MCP tool returns).

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.