Rankhog Docs
DocsCLIMCPAPI
API Reference

Get product setup and report

Where a product's setup stands, and the next step to tell the person. While the free Reddit SEO report builds, the step it is on.

POST
/agent/v1/setup/product/status

Where a product's setup stands, and the next step to tell the person. While the free Reddit SEO report builds, the step it is on. When it's ready, the report in short and links.report. Without a plan, links.trial is the Rankhog page where the person starts the 7-day trial and pays at Stripe themselves; a card is needed. Once active, links.desktopSetup is where they connect Rankhog Desktop and a Reddit account. Leave productId out to read the product being set up. Cache policy: live. Idempotency: none. Auth modes: mcp_oauth, session_bearer.

Authorization

AuthorizationBearer <token>

In: header

Scope: rankhog:read

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/agent/v1/setup/product/status" \  -H "Content-Type: application/json" \  -d '{    "productId": "site_demo"  }'
{  "checkAfterSeconds": 20,  "links": {    "dashboard": null,    "desktopSetup": null,    "report": "https://rankhog.com/product/site_demo/onboarding/review",    "trial": null  },  "message": "Rankhog is building the free Reddit SEO report. It's on: Check Google searches. Check again in about 20 seconds.",  "plan": {    "cardRequired": true,    "name": "Growth",    "price": "$99/month",    "trialDays": 7  },  "product": {    "id": "site_demo",    "name": "SupportLeaf",    "websiteUrl": "https://supportleaf.example"  },  "report": {    "steps": [      {        "label": "Save your answers",        "status": "completed"      },      {        "label": "Check Google searches",        "status": "running"      }    ],    "summary": null  },  "stage": "building_report"}
{  "error": {    "code": "agentic_invalid_input",    "message": "Invalid capability input."  }}
{  "error": {    "code": "agentic_human_actor_required",    "message": "This agentic capability requires a human-authenticated Rankhog user."  }}
{  "error": {    "code": "agentic_not_found",    "message": "Website not found."  }}

Set up a product and its free report POST

Set up a product in Rankhog from its website and build the free Reddit SEO report: which Google searches show Reddit threads, where the product ranks...

Get Desktop setup status POST

Inspect product browser readiness and setup blockers without exposing device credentials or raw browser control.