Common workflows
Learn the standard tool sequences for running tests, creating monitors, querying metrics, and investigating incidents on the platform.
These recipes show the tool order for the tasks agents run most often. Each step names the tool to call.
Before a multi-step task, call platform_guide with the relevant topic (for example test_creation or metrics). It returns the up-to-date sequence and prerequisites straight from the server.
Run a test
list_tests with a product slug, or search_collections to find it in the folder tree.
get_test_detail to see required input variables and owners.
build_campaign to assemble the run (pass a variants array to pick an environment), then run_campaign.
poll_execution until it finishes, then get_execution_detail for per-test pass/fail data.
Create a monitor
list_tests for the test id, and list_variable_groups for the variable group that holds your environment.
create_monitor with the product, test id, variable group, and schedule.
toggle_monitors to turn monitors on or off in bulk.
Query metrics
query_metrics with SHOW MEASUREMENTS and SHOW FIELD KEYS to discover what is collected.
query_metrics with a SELECT to read KPI time series, then compute_slo or correlate_metrics for deeper analysis.
Investigate incidents
get_incident_counter for a quick critical / warning / closed count.
list_incidents filtered by status, then get_incident for detail.
close_incident once the underlying issue is handled.
What's next?
Last updated on