Back to docs

Tool Site Model Query

Category: Site Knowledge · Since: v18.35.0 · Tier: All

Query the site model for the best known path to a goal on a domain. Returns the most successful action sequence from previous interactions.

Parameters

Parameter Type Required Default Description
domain string Yes — Domain to query
goalType enum Yes — Type of goal: find_information, complete_action, navigate_to, fill_form, compare, explore, extract_data

Examples

What's the best path to find information on example.com?

Query the site model for how to complete an action on our checkout flow

Response

{
  "found": true,
  "goalType": "find_information",
  "bestPath": {
    "goalDescription": "find pricing information",
    "successRate": 0.85,
    "attemptCount": 7,
    "averageSteps": 3,
    "actionSequence": [
      { "type": "click", "target": "Pricing", "expectedOutcome": "Navigate to pricing page" },
      { "type": "scroll", "target": "down", "expectedOutcome": "Reveal pricing table" },
      { "type": "extract", "target": "pricing table", "expectedOutcome": "Get pricing data" }
    ],
    "personaPerformance": {
      "first-timer": { "success": true, "steps": 4 },
      "power-user": { "success": true, "steps": 2 }
    }
  }
}

Goal Types

Type Description Example
find_information Locate specific information "Find the application deadline"
complete_action Execute a workflow "Sign up for an account"
navigate_to Reach a specific page "Go to the pricing page"
fill_form Complete a form "Fill out the contact form"
compare Compare options "Compare pricing plans"
explore Browse and discover "Explore the documentation"
extract_data Pull structured data "Get all product prices"

Related

From the Blog