> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get link locator

> Read matching occurrence positions and context from one retained snapshot.

`get_link_locator`

Read matching occurrence positions and context from one retained snapshot. No current visual visibility or new crawl.

<Note>Available in the deployed MCP and HTTP bundle. Confirm access and inputs with your connected catalog. Workspace scopes and enabled providers still apply.</Note>

| Access         | Behavior         |
| -------------- | ---------------- |
| `watches:read` | Reads saved data |

This read does not start a verification job.

## Example request

Connect through [MCP](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "get_link_locator",
      "arguments": {
        "projectId": "project_example",
        "watchId": "watch_example",
        "observationId": "observation_example",
        "limit": 50
      }
    }
  }
  ```

  ```bash CLI theme={null}
  agentlinkops call get_link_locator --args '{"projectId":"project_example","watchId":"watch_example","observationId":"observation_example","limit":50}'
  ```

  ```bash HTTP theme={null}
  curl "$AGENTLINKOPS_API_URL/v1/commands/get_link_locator" \
    -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
    -H 'Content-Type: application/json' \
    --data '{"projectId":"project_example","watchId":"watch_example","observationId":"observation_example","limit":50}'
  ```
</CodeGroup>

## Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.

```json theme={null}
{
  "workspace_id": "workspace_example",
  "project_id": "project_example",
  "watch_id": "watch_example",
  "observation_id": "observation_example",
  "observed_at": "2026-09-20T00:00:00.000Z",
  "latest": false,
  "basis": "retained_observation",
  "availability": "not_present",
  "total_occurrences": 0,
  "items": [],
  "next_offset": null,
  "notes": [
    "This example is a retained historical observation, not a fresh check."
  ]
}
```

## Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

| Field           | Type    | Presence | Meaning and constraints                                                                              |
| --------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `projectId`     | string  | Required | Identifier of the project returned by its create or list operation. minLength: 1; maxLength: 200     |
| `watchId`       | string  | Required | Identifier of the watch returned by its create or list operation. minLength: 1; maxLength: 200       |
| `observationId` | string  | Required | ID of a saved observation; this does not fetch a new publisher page. minLength: 1; maxLength: 200    |
| `offset`        | integer | Optional | The offset value; allowed values and bounds are specified in this schema. minimum: 0; maximum: 999   |
| `limit`         | integer | Optional | Maximum rows in this page or bounded report; subject to the schema maximum. minimum: 1; maximum: 100 |

### Validation and omitted values

Uses retained observations and optional frozen competitor inventories. Dataset coverage and denominators stay separate; missing evidence is unknown.

Index status requires a selected retained source timeline. Locator output is a dated snapshot, never a fresh crawl or proof of current visibility.

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.

* **`workspace_id`** (string, required): Workspace that owns this record. minLength: 1; maxLength: 200
* **`project_id`** (string, required): Project that owns this record. minLength: 1; maxLength: 200
* **`watch_id`** (string, required): Identifier returned by the related operation. minLength: 1; maxLength: 200
* **`observation_id`** (string, required): Identifier returned by the related operation. minLength: 1; maxLength: 200
* **`observed_at`** (string, required): UTC timestamp of the observation used here.
* **`latest`** (boolean, required).
* **`basis`** (string, required): must equal "retained\_observation"
* **`availability`** (string, required): values: "complete", "incomplete", "not\_present"
* **`total_occurrences`** (integer, required): minimum: 0; maximum: 9007199254740991
* **`items`** (array, required): Records in this bounded page.
* **`next_offset`** (integer / null, required).
* **`notes`** (array, required).

<Accordion title="All fields and nested objects">
  | Field                      | Type           | Presence | Meaning and constraints                                                    |
  | -------------------------- | -------------- | -------- | -------------------------------------------------------------------------- |
  | `workspace_id`             | string         | Required | Workspace that owns this record. minLength: 1; maxLength: 200              |
  | `project_id`               | string         | Required | Project that owns this record. minLength: 1; maxLength: 200                |
  | `watch_id`                 | string         | Required | Identifier returned by the related operation. minLength: 1; maxLength: 200 |
  | `observation_id`           | string         | Required | Identifier returned by the related operation. minLength: 1; maxLength: 200 |
  | `observed_at`              | string         | Required | UTC timestamp of the observation used here.                                |
  | `latest`                   | boolean        | Required |                                                                            |
  | `basis`                    | string         | Required | must equal "retained\_observation"                                         |
  | `availability`             | string         | Required | values: "complete", "incomplete", "not\_present"                           |
  | `total_occurrences`        | integer        | Required | minimum: 0; maximum: 9007199254740991                                      |
  | `items`                    | array          | Required | Records in this bounded page.                                              |
  | `items[].occurrence_index` | integer        | Required | minimum: 0; maximum: 9007199254740991                                      |
  | `items[].anchor`           | string / null  | Required |                                                                            |
  | `items[].target_url`       | string / null  | Required | Destination URL recorded in this evidence.                                 |
  | `items[].rel`              | array / null   | Required |                                                                            |
  | `items[].context`          | string / null  | Required |                                                                            |
  | `items[].location`         | object / null  | Required |                                                                            |
  | `items[].location.line`    | integer        | Required | minimum: 0; maximum: 9007199254740991                                      |
  | `items[].location.column`  | integer        | Required | minimum: 0; maximum: 9007199254740991                                      |
  | `items[].location.offset`  | integer        | Required | minimum: 0; maximum: 9007199254740991                                      |
  | `items[].visibility`       | string / null  | Required |                                                                            |
  | `next_offset`              | integer / null | Required |                                                                            |
  | `notes`                    | array          | Required |                                                                            |
</Accordion>

[Download input schema](/schemas/get_link_locator.input.json) · [Download output schema](/schemas/get_link_locator.output.json)

## Errors and retries

The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict.

See [error recovery](/reference/errors) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

## HTTP resource routes

This operation has no separate resource alias. Use its generic command route in a matching environment.

## Continue

[get\_profile\_distributions](/reference/commands/get_profile_distributions) · [export\_profile\_distribution](/reference/commands/export_profile_distribution)

Follow the [related workflow](/guides/sync-and-export), inspect [capability status](/capability-status), or return to the [command index](/reference/index).