YepAPI/skills

Competitor Research Workflow

Competitive analysis between domains using YepAPI endpoints.

Endpoints Used

Endpoint	Cost	Purpose
POST /v1/seo/domain/overview	$0.01	Traffic, keywords, backlinks, domain rank
POST /v1/seo/competitors	$0.04	SEO competitor domains by keyword overlap
POST /v1/seo/keyword-gap	$0.04	Keyword gap analysis between two domains

Workflow

Step 1: Domain Overview

Run POST /v1/seo/domain/overview on the user's domain.

{
  "domain": "example.com"
}

Returns: organic traffic, total keywords, backlinks count, domain rank.

Step 2: Discover Competitors

Run POST /v1/seo/competitors on the user's domain.

{
  "domain": "example.com"
}

Returns: competitor domains with keyword overlap percentage and traffic estimates.

Step 3: Compare Top Competitors

For the top 2-3 competitors, run POST /v1/seo/domain/overview on each.

{
  "domain": "competitor.com"
}

Compare: traffic, keyword counts, backlink profiles, domain rank.

Step 4: Keyword Gap Analysis

Run POST /v1/seo/keyword-gap between the user's domain and the top competitor.

{
  "domain": "example.com",
  "competitor": "competitor.com"
}

Returns: keywords the competitor ranks for that the user doesn't — sorted by volume and difficulty.

Step 5: Present Findings

• Who's winning overall (traffic, authority)
• Where the keyword gaps are (high-value terms the user is missing)
• What to target next (prioritized by opportunity: high volume + low difficulty)

Rules

• Start with domain overview — cheapest at $0.01, gives baseline metrics
• Limit competitor deep-dives to top 3 — controls cost
• Keyword gap analysis is the most actionable output — always include it

Error Handling

• NO_CREDITS (402) — Tell the user to add credits at https://yepapi.com/dashboard
• UPSTREAM_ERROR (502) — Retry once; if it fails again, skip that step and note it
• VALIDATION_ERROR (400) — Check domain format; use bare domain without protocol
• RATE_LIMITED (429) — Wait and retry; respect the Retry-After header