Files
AutoGPT/docs/integrations/dataforseo/keyword_suggestions.md
Nicholas Tindle c1a1767034 feat(docs): Add block documentation auto-generation system (#11707)
- Add generate_block_docs.py script that introspects block code to
generate markdown
- Support manual content preservation via <!-- MANUAL: --> markers
- Add migrate_block_docs.py to preserve existing manual content from git
HEAD
- Add CI workflow (docs-block-sync.yml) to fail if docs drift from code
- Add Claude PR review workflow (docs-claude-review.yml) for doc changes
- Add manual LLM enhancement workflow (docs-enhance.yml)
- Add GitBook configuration (.gitbook.yaml, SUMMARY.md)
- Fix non-deterministic category ordering (categories is a set)
- Add comprehensive test suite (32 tests)
- Generate docs for 444 blocks with 66 preserved manual sections

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

<!-- Clearly explain the need for these changes: -->

### Changes 🏗️

<!-- Concisely describe all of the changes made in this pull request:
-->

### Checklist 📋

#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
  <!-- Put your test plan here: -->
  - [x] Extensively test code generation for the docs pages



<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Introduces an automated documentation pipeline for blocks and
integrates it into CI.
> 
> - Adds `scripts/generate_block_docs.py` (+ tests) to introspect blocks
and generate `docs/integrations/**`, preserving `<!-- MANUAL: -->`
sections
> - New CI workflows: **docs-block-sync** (fails if docs drift),
**docs-claude-review** (AI review for block/docs PRs), and
**docs-enhance** (optional LLM improvements)
> - Updates existing Claude workflows to use `CLAUDE_CODE_OAUTH_TOKEN`
instead of `ANTHROPIC_API_KEY`
> - Improves numerous block descriptions/typos and links across backend
blocks to standardize docs output
> - Commits initial generated docs including
`docs/integrations/README.md` and many provider/category pages
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
631e53e0f6. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 07:03:19 +00:00

3.7 KiB

Dataforseo Keyword Suggestions

Blocks for getting keyword suggestions with search volume and competition metrics from DataForSEO.

Data For Seo Keyword Suggestions

What it is

Get keyword suggestions from DataForSEO Labs Google API

How it works

This block calls the DataForSEO Labs Google Keyword Suggestions API to generate keyword ideas based on a seed keyword. It provides search volume, competition metrics, CPC data, and keyword difficulty scores for each suggestion.

Configure location and language targeting to get region-specific results. Optional SERP and clickstream data provide additional insights into search behavior and click patterns.

Inputs

Input Description Type Required
keyword Seed keyword to get suggestions for str Yes
location_code Location code for targeting (e.g., 2840 for USA) int No
language_code Language code (e.g., 'en' for English) str No
include_seed_keyword Include the seed keyword in results bool No
include_serp_info Include SERP information bool No
include_clickstream_data Include clickstream metrics bool No
limit Maximum number of results (up to 3000) int No

Outputs

Output Description Type
error Error message if the operation failed str
suggestions List of keyword suggestions with metrics List[KeywordSuggestion]
suggestion A single keyword suggestion with metrics KeywordSuggestion
total_count Total number of suggestions returned int
seed_keyword The seed keyword used for the query str

Possible use case

Content Planning: Generate blog post and article ideas based on keyword suggestions with high search volume.

SEO Strategy: Discover new keyword opportunities to target based on competition and difficulty metrics.

PPC Campaigns: Find keywords for advertising campaigns using CPC and competition data.


Keyword Suggestion Extractor

What it is

Extract individual fields from a KeywordSuggestion object

How it works

This block extracts individual fields from a KeywordSuggestion object returned by the Keyword Suggestions block. It decomposes the suggestion into separate outputs for easier use in workflows.

Each field including keyword text, search volume, competition level, CPC, difficulty score, and optional SERP/clickstream data becomes available as individual outputs for downstream processing.

Inputs

Input Description Type Required
suggestion The keyword suggestion object to extract fields from KeywordSuggestion Yes

Outputs

Output Description Type
error Error message if the operation failed str
keyword The keyword suggestion str
search_volume Monthly search volume int
competition Competition level (0-1) float
cpc Cost per click in USD float
keyword_difficulty Keyword difficulty score int
serp_info data from SERP for each keyword Dict[str, Any]
clickstream_data Clickstream data metrics Dict[str, Any]

Possible use case

Keyword Filtering: Extract search volume and difficulty to filter keywords meeting specific thresholds.

Data Analysis: Access individual metrics for comparison, sorting, or custom scoring algorithms.

Report Generation: Pull specific fields like CPC and competition for SEO or PPC reports.