-
Notifications
You must be signed in to change notification settings - Fork 0
Keywords
briansemify edited this page Oct 21, 2025
·
9 revisions
Endpoint: POST /api/v1/keywords/budget/estimate
Purpose: Generate comprehensive budget estimates for organic keywords based on SEMrush data analysis with trend analysis and recommendations.
Required Fields:
-
url(string): Client business domain URL to analyze
Optional Fields:
-
categories(array): Business categories for filtering -
seeds(array): Seed keywords for analysis -
market(string): Country/locale code (default: "us") -
language(string): Language code (default: "en") -
max_keywords(integer): Maximum keywords to return (default: 50)
Request Example:
{
"url": "https://example.com",
"categories": ["digital marketing", "seo services"],
"seeds": ["best seo", "digital marketing agency"],
"market": "us",
"language": "en",
"max_keywords": 25
}Response:
{
"data": {
"url": "https://example.com",
"market": "us",
"language": "en",
"total_keywords": 25,
"cached": false,
"keywords": [
{
"keyword": "best seo tools",
"cpc": 3.45,
"monthly_searches": 1200,
"position": "5",
"position_credit": 15.75,
"cost": 84.25,
"value": 3,
"trend": "upward",
"competition": 0.7,
"budget_tier": "medium",
"volume_category": "medium"
}
],
"summary": {
"total_monthly_cost": 2106.25,
"average_cost_per_keyword": 84.25,
"high_value_keywords": 8,
"budget_friendly_keywords": 12,
"premium_keywords": 5
}
},
"messages": [
"Budget estimation completed successfully"
],
"pagination": {
"totalPages": 1,
"maxRows": 0,
"offset": 0,
"page": 1,
"totalRecords": 25
},
"error": false
}Features:
- Dynamic Calculations: User-specific budget configurations
- Trend Multipliers: Budget adjustments based on keyword trends
- Value Scoring: Automatic value assessment (1-5 scale)
- Budget Tiers: High, medium-high, medium, low-medium, low
- Volume Categories: High, medium, decent, low volume
- Position Credits: Cost adjustments based on current rankings
- Summary Analytics: Total costs and keyword distribution
- Create: POST /api/v1/keywords
- Read: GET /api/v1/keywords/accounts/{account_id}/campaigns/{campaign_id}
- Update: PUT /api/v1/keywords/{rank_id}
- Delete: DELETE /api/v1/keywords/{rank_id}
- Run budget estimates FIRST before creating accounts or campaigns
- Store keyword IDs returned by the API for later updates or reporting
- Use attributes to save tags, priority, or external IDs
- Analyze budget estimates to determine appropriate service plans