---
title: "start_competitor_analysis"
method: POST
path: "/v1/competitor-analyses"
---

# start_competitor_analysis

`POST /v1/competitor-analyses`

## Request

- Base URL: `https://app.agentlinkops.com`
- URL: `https://app.agentlinkops.com/v1/competitor-analyses`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Supply input in the JSON body, including idempotencyKey and consent. This route does not read an Idempotency-Key header. HTTP202 returns saved background intent; supplier admission is required.

## Headers

- `X-Workspace-ID` string

## Request body

- object
  - `projectId` string, required: project ID from create/list.
  - `setId` string, required: set ID from create/list.
  - `revision` integer, required: Revision of the approved competitor set bound to this offer or run. Pass the current set revision as revision when preparing an offer.
  - `memberId` string, required: member ID from create/list.
  - `idempotencyKey` string, required: Caller-generated key reused only for retries of the same operation and arguments in this workspace.
  - `consent` true, required: consent; see schema.

## Response `202`

Supply input in the JSON body, including idempotencyKey and consent. This route does not read an Idempotency-Key header. HTTP202 returns saved background intent; supplier admission is required.

- object
  - `schema_version` 1, required
  - `id` string, required: Resource identifier returned by the operation.
  - `workspace_id` string, required: Workspace that owns this record.
  - `project_id` string, required: Project that owns this record.
  - `competitor_binding` object, required
    - `setId` string, required
    - `revision` integer, required: Revision of the approved competitor set bound to this offer or run. Pass the current set revision as revision when preparing an offer.
    - `memberId` string, required
  - `scope` object, required
    - `domain` string, required
    - `include_subdomains` boolean, required
  - `state` 'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'stopped', required: Saved lifecycle or evidence state, as enumerated for this record.
  - `stages` object, required
    - `retrieval` object, required
      - `state` 'not_started' | 'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'unavailable' | 'stopped', required: Saved lifecycle or evidence state, as enumerated for this record.
      - `error_code` string, nullable, required: Latest delivery detail code; null when no failure or retry has been recorded.
      - `updated_at` string, date-time, required: UTC timestamp of the last record update.
    - `source_checks` object, required
      - `state` 'not_started' | 'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'unavailable' | 'stopped', required: Saved lifecycle or evidence state, as enumerated for this record.
      - `error_code` string, nullable, required: Latest delivery detail code; null when no failure or retry has been recorded.
      - `updated_at` string, date-time, required: UTC timestamp of the last record update.
    - `occurrence_context` object, required
      - `state` 'not_started' | 'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'unavailable' | 'stopped', required: Saved lifecycle or evidence state, as enumerated for this record.
      - `error_code` string, nullable, required: Latest delivery detail code; null when no failure or retry has been recorded.
      - `updated_at` string, date-time, required: UTC timestamp of the last record update.
    - `assessment` object, required
      - `state` 'not_started' | 'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'unavailable' | 'stopped', required: Saved lifecycle or evidence state, as enumerated for this record.
      - `error_code` string, nullable, required: Latest delivery detail code; null when no failure or retry has been recorded.
      - `updated_at` string, date-time, required: UTC timestamp of the last record update.
  - `baseline_run_id` string, nullable, required
  - `inventory_id` string, nullable, required
  - `created_at` string, date-time, required: UTC timestamp when the record was created.
  - `updated_at` string, date-time, required: UTC timestamp of the last record update.
  - `last_activity_at` string, date-time, required
  - `next_eligible_at` string, date-time, required
  - `retrieval_deadline` string, date-time, required
  - `attempt_count` integer, required
  - `retry_count` integer, required
  - `last_error_code` string, nullable, required
  - `recurring_monitoring_created` false, required: Whether this operation enrolled recurring monitoring.
  - `replayed` boolean: True when the response reuses an earlier request with the same idempotency value.
  - `retrieval` object
    - `id` string, required: Resource identifier returned by the operation.
    - `analysis_id` string, required
    - `state` 'pending' | 'running' | 'complete' | 'partial' | 'failed' | 'stopped' | 'reconciliation_required', required: Saved lifecycle or evidence state, as enumerated for this record.
    - `evidence_revision` integer, required
    - `snapshot_id` string, nullable, required
    - `coverage` 'not_retrieved' | 'complete_provider_query' | 'partial_provider_query', required: Dataset scope and completeness, including limits on what these results establish.
    - `counts` object, required
      - `pages` integer, required
      - `returned_rows` integer, required
      - `accepted_candidates` integer, required
      - `provider_total_count` integer, nullable, required
    - `last_activity_at` string, date-time, required
    - `next_eligible_at` string, date-time, required
    - `expires_at` string, date-time, required
    - `reason` string, nullable, required: Recorded explanation; null when no explanation applies.

## Other responses

- `429`: Request-rate or usage refusal. Inspect error.code and recovery details before retrying.
- `default`: Error envelope. Non-configuration 5xx messages are masked and details omitted; allowlisted configuration errors retain static operator recovery.

---

[API](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api.md) · [All operations](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/revisions/2a712a1dcfa7?raw)