List Experiment Keywords
list_experiment_keywordsSearch and browse keywords running in experiments with simplified response data.
PURPOSE:
Retrieve a paginated list of keywords that are currently running in experiments,
with optional filtering by keyword or experiment name. Returns only essential fields
for quick identification: keyword name, keywordExternalId, wizExperimentId, wizExperimentName, and status.
WHEN TO USE:
- Find keywords running in a specific experiment
- Search for a keyword across all experiments
- Look up keywordExternalId and wizExperimentId before pausing a keyword
- Browse experiment keywords with pagination
- Verify the status of a keyword after calling pause_experiment_keyword
(note: pausing is an async flow, so the status may take some time to update)
RESPONSE FORMAT:
Returns a simplified paginated response:
{
"totalElements": 50,
"totalPages": 5,
"data": [
{
"keyword": "digital marketing",
"keywordExternalId": 12345,
"wizExperimentId": 678,
"wizExperimentName": "Q1 Campaign Test",
"status": "ACTIVE",
"primaryStatus": "NOT_ELIGIBLE",
"primaryStatusReasons": ["CAMPAIGN_PAUSED", "CAMPAIGN_PENDING"]
}
]
}
COMMON USE CASES:
1. Search by experiment name:
list_experiment_keywords(keywordOrExperimentName="Q1 Campaign")
2. Search by keyword:
list_experiment_keywords(keywordOrExperimentName="marketing")
3. Paginate through results:
list_experiment_keywords(keywordOrExperimentName="test", page=0, size=20)
list_experiment_keywords(keywordOrExperimentName="test", page=1, size=20)
PARAMETERS:
- keywordOrExperimentName: Required. Search term to filter by keyword or experiment name.
- page: Page number for pagination (0-based, default: 0)
- size: Number of items per page (default: 10)
TIP: Use this tool first to find the keywordExternalId and wizExperimentId needed
by the pause_experiment_keyword tool.Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (0-based). Default is 0. | |
| size | No | Number of items per page. Default is 10. | |
| keywordOrExperimentName | Yes | Search term to filter results by keyword name or experiment name. |