Integrations

Keyword Warehouse

10 actions for Keyword Warehouse.

Cannibalization Report#

Returns paid spend on keywords already ranking organically.

Plans: Trial, Pro, Premium, Enterprise · Type: CannibalizationReport · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date plus optional position threshold.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: cannibalization_report

Returns paid spend on keywords already ranking organically.

Keyword Drilldown#

Returns time series, pages, ad groups, and prompt matches for one keyword.

Plans: Trial, Pro, Premium, Enterprise · Type: KeywordDrilldown · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date and required keyword_norm.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: keyword_drilldown

Returns time series, pages, ad groups, and prompt matches for one keyword.

Keyword Gaps#

Returns paid-only, organic-not-bid, or engine-gap keyword rows.

Plans: Trial, Pro, Premium, Enterprise · Type: KeywordGaps · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date, variant, and optional thresholds.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: keyword_gaps

Returns paid-only, organic-not-bid, or engine-gap keyword rows.

Keyword Matrix#

Returns the cross-platform keyword matrix with filters, sorting, and presets.

Plans: Trial, Pro, Premium, Enterprise · Type: KeywordMatrix · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date plus optional filters, sort, preset, comparison, brand, limit, and offset.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: keyword_matrix

Returns the cross-platform keyword matrix with filters, sorting, and presets.

Keyword Movers#

Returns the largest position, spend, and CTR changes between periods.

Plans: Trial, Pro, Premium, Enterprise · Type: KeywordMovers · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date plus optional sort and limit.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: movers

Returns the largest position, spend, and CTR changes between periods.

Keyword Page Join#

Returns organic and paid aggregates joined at landing-page grain.

Plans: Trial, Pro, Premium, Enterprise · Type: KeywordPageJoin · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date plus optional pagination.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: page_join

Returns organic and paid aggregates joined at landing-page grain.

Keyword Warehouse Query#

Runs any supported keyword warehouse report from one schedulable node.

Plans: Trial, Pro, Premium, Enterprise · Type: KeywordWarehouseQuery · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Report TypeTextYesmoversOptions: cannibalization_report, keyword_drilldown, keyword_gaps, keyword_matrix, movers, page_join, paid_vs_organic_quadrant, share_of_search, sync_status
Domain IDTextYes(empty)
Report ParametersObjectNo—Report-specific parameters as JSON.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: keyword_warehouse_query

Runs any supported keyword warehouse report from one schedulable node.

Keyword Warehouse Sync Status#

Returns the current keyword import status for every mapped platform.

Plans: Trial, Pro, Premium, Enterprise · Type: KeywordWarehouseSyncStatus · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: sync_status

Returns the current keyword import status for every mapped platform.

Returns paid-versus-organic keyword quadrant rows.

Plans: Trial, Pro, Premium, Enterprise · Type: PaidVsOrganicQuadrant · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date plus optional quadrant thresholds.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: paid_vs_organic_quadrant

Returns paid-versus-organic keyword quadrant rows.

Returns paid and organic share-of-search series by platform.

Plans: Trial, Pro, Premium, Enterprise · Type: ShareOfSearch · Beta

Inputs#

FieldTypeRequiredDefaultWhat it does
Domain IDTextYes(empty)
Report ParametersObjectNo—ISO start_date/end_date plus optional comparison and brand segment.

Outputs#

OutputType
RowsList
SummaryText

Use as an agent tool#

Tool name: share_of_search

Returns paid and organic share-of-search series by platform.