--- title: "preview_competitor_exclusions" method: POST path: "/v1/competitor-sets/{setId}/exclusions/preview" --- # preview_competitor_exclusions `POST /v1/competitor-sets/{setId}/exclusions/preview` ## Request - Base URL: `https://app.agentlinkops.com` - URL: `https://app.agentlinkops.com/v1/competitor-sets/{setId}/exclusions/preview` - Auth: one of: - HTTP bearer - HTTP bearer Remaining arguments go in a JSON object body. ## Path parameters - `setId` string, required: set ID from create/list. ## Headers - `X-Workspace-ID` string ## Request body - object - `revision` integer, required: Immutable set revision to read/compare. - `inventoryIds` string[], required: Frozen inventory IDs to compare within the approved set. - `grouping` 'page' | 'source_host', required: Aggregate selected inventories by this dimension. - `exclusions` object[]: Customer-approved exclusions to apply to this report. - `grouping` 'page' | 'source_host', required - `value` string, required - `maxRetrievalSkewMs` integer: Maximum inventory retrieval-time skew in milliseconds. - `exclusionRevision` integer: Saved exclusion revision; historical revisions stay immutable. ## Response `200` Remaining arguments go in a JSON object body. - object - `v` number, required - `set_id` string, required - `set_revision` number, required - `grouping` string, required - `comparison` object, required - `mode` string, required - `reasons` string[], required - `absence_claim` 'not_supported', required: not_supported: missing dataset rows cannot prove link absence. - `absence_claim` 'not_supported', required: not_supported: missing dataset rows cannot prove link absence. - `whole_web_coverage` false, required: False: these results do not measure the whole web. - `coverage_scope` string, required - `verification_view` string, required - `max_retrieval_skew_ms` number, required - `selected_inventory_ids` string[], required - `unselected_member_ids` string[], required - `exclusions` object, required - `scope` string, required - `policy` string, required - `rules` object[], required - `grouping` 'page' | 'source_host', required - `value` string, required - `saved_revision` number - `set_revision_at_save` number - `inventories` object[], required - `v` number, 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. - `set_id` string, required - `set_revision` number, required - `set_hash` string, required - `member_id` string, required - `member_role` string, required - `target_scope_id` string, required - `captured_at` string, required - `provider_retrieved_from` string, nullable, required - `provider_retrieved_to` string, nullable, required - `run` object, required - `v` 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. - `provider` 'linktrail_corpus' | 'dataforseo' | 'imported', required - `data_mode` 'synthetic' | 'owned_corpus' | 'provider_index' | 'imported', required - `query` object, required - `target_kind` 'domain' | 'exact_url', required - `target` string, required - `include_subdomains` boolean, required - `backlinks_status_type` 'live' | 'lost' | 'all', required - `exclude_internal_backlinks` boolean, required - `mode` 'as_is', required - `filters` unknown, required - `rank_scale` 'one_thousand', nullable, required - `page_limit` integer, required - `row_limit` integer, required - `status` 'queued' | 'running' | 'succeeded' | 'partial' | 'failed' | 'reconciliation_required', required: Resource lifecycle status. - `created_at` string, date-time, required: UTC timestamp when the record was created. - `started_at` string, date-time, nullable, required - `finished_at` string, date-time, nullable, required - `coverage` 'pending' | 'complete_for_query' | 'capped' | 'partial' | 'unknown', required: Dataset scope and completeness, including limits on what these results establish. - `coverage_reason` string, nullable, required - `provider_total_count` integer, nullable, required - `usage` object, required - `unit` 'discovery', required - `currency` 'USD', required - `quote_id` string, required - `max_cost_microusd` integer, required - `reserved_cost_microusd` integer, required - `provider_reported_cost_microusd` integer, nullable, required - `request_count` integer, required - `returned_rows` integer, required - `accepted_candidates` integer, required - `rejected_rows` integer, required - `duplicate_rows` integer, required - `operation` 'backlinks', required - `coverage_scope` 'customer_import' | 'corpus_subset' | 'provider_query', required - `whole_web_coverage` false, required: False: these results do not measure the whole web. - `replayed` boolean: True when the response reuses an earlier request with the same idempotency value. - `content_hash` string, required - `absence_claim` 'not_supported', required: not_supported: missing dataset rows cannot prove link absence. - `verification_view` 'captured_at_snapshot', required - `replayed` boolean: True when the response reuses an earlier request with the same idempotency value. - `baseline_report_hash` string, required - `preview_hash` string, required - `dry_run` true, required - `before_counts` object, nullable, required - `groups` number, required - `rows` number, required - `observed_overlap_groups` number, required - `dataset_gap_groups` number, nullable, required - `comparison_unknown_groups` number, required - `excluded_groups` number, required - `excluded_rows` number, required - `after_counts` object, nullable, required - `groups` number, required - `rows` number, required - `observed_overlap_groups` number, required - `dataset_gap_groups` number, nullable, required - `comparison_unknown_groups` number, required - `excluded_groups` number, required - `excluded_rows` number, required - `per_rule` object[], required - `rule` object, required - `grouping` 'page' | 'source_host', required - `value` string, required - `matched_rows` number, nullable, required - `hidden_groups` number, nullable, required - `hidden_rows` number, nullable, required - `per_rule_counts_overlap` boolean, required - `examples` object[], required - `group_key` string, required: Exact group identifier used to retrieve contributor rows. - `relation` string, required - `hidden_rows` number, required - `matched_rows` number, required - `collateral_rows` number, required - `matches` object[], required - `candidate_id` string, required - `source_url` string, required: Publisher page URL recorded in this evidence. - `target_url` string, required: Destination URL recorded in this evidence. - `inventory_id` string, required - `member_id` string, required - `member_role` string, required - `rule_indexes` number[], required - `matches_truncated` boolean, required - `examples_truncated` boolean, required - `example_limits` object, required - `groups` number, required - `matches_per_group` number, required ## 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)