Skip to main content
POST
/
api
/
agent
/
competitors
/
scout
Analyze a competitor domain
curl --request POST \
  --url https://www.citedy.com/api/agent/competitors/scout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "mode": "fast",
  "topic": "<string>",
  "language": "en"
}
'
{
  "domain": "<string>",
  "mode": "fast",
  "intelligence": {
    "strengths": [
      "<string>"
    ],
    "weaknesses": [
      "<string>"
    ],
    "opportunities": [
      "<string>"
    ],
    "threats": [
      "<string>"
    ],
    "content_strategy": "<string>",
    "estimated_monthly_traffic": 123,
    "top_content_categories": [
      "<string>"
    ]
  },
  "credits_used": 123
}

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
domain
string<uri>
required
mode
enum<string>
default:fast
Available options:
fast,
ultimate
topic
string
Required string length: 1 - 500
language
string
default:en
Required string length: 2 - 5

Response

Competitor analysis complete

domain
string
required
mode
enum<string>
required
Available options:
fast,
ultimate
intelligence
object
required
credits_used
integer
required