Skip to content
Browse docsget_goal_search

get_goal_search

Reads saved search status and current coverage for one owned goal. Reading starts no work, changes nothing, and never waits for a search to finish.

Annotations: readOnlyHint: true · destructiveHint: false · idempotentHint: true · openWorldHint: false

Inputs#

InputRequiredTypeDescription
goalIdyesstringExact owned goal UUID

Returns#

goalId, scopeVersion, queuedBySetup, nullable searchableNetworkCount, and nullable run. The run reports saved status, activities, progress, dates, result count, current coverage, and eligible/unfinished network counts. Dates describe saved work; coverage and eligibility reflect current information for the current goal scope. run: null means no run is saved for that scope, not that earlier scopes were never searched. Missing or unowned goals return unavailable.

Read list_goal_search_networks for eligible or unfinished network identities. These are member networks, never their contacts or evidence of willingness. Read get_goal with Full view for saved match reasons.

Example#

json
{ "goalId": "00000000-0000-4000-a000-000000000001" }

Result (synthetic data):

json
{
  "goalId": "00000000-0000-4000-a000-000000000001",
  "scopeVersion": 2,
  "queuedBySetup": false,
  "searchableNetworkCount": null,
  "run": {
    "id": "00000000-0000-4000-a000-000000000002",
    "scopeVersion": 2,
    "status": "running",
    "stage": "searching",
    "activities": [
      "researching"
    ],
    "progress": {
      "estimatedPercent": 50,
      "completedNetworks": 1,
      "totalNetworks": 2,
      "completedTurns": 3
    },
    "coverage": {
      "searchedNetworks": 1,
      "totalNetworks": 2
    },
    "resultCount": 1,
    "incomplete": false,
    "stalled": false,
    "eligibleNetworkCount": 1,
    "failedNetworkCount": 0,
    "startedAt": "2026-10-09T00:00:00.000Z",
    "completedAt": null,
    "updatedAt": "2026-10-09T00:01:00.000Z"
  }
}