preview_competitor_exclusions

Remaining arguments go in a JSON object body.

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

Path parameters

setIdstring required

set ID from create/list.

Headers

X-Workspace-IDstring

Required when using a Clerk human session. With an API key, omit this header or supply its bound workspace.

Request body

revisioninteger required

Immutable set revision to read/compare.

inventoryIdsstring[] required

Frozen inventory IDs to compare within the approved set.

grouping'page' | 'source_host' required

Aggregate selected inventories by this dimension.

maxRetrievalSkewMsinteger

Maximum inventory retrieval-time skew in milliseconds.

exclusionRevisioninteger

Saved exclusion revision; historical revisions stay immutable.

Response

Remaining arguments go in a JSON object body.

vnumber required
set_idstring required
set_revisionnumber required
groupingstring required
absence_claim'not_supported' required

not_supported: missing dataset rows cannot prove link absence.

whole_web_coveragefalse required

False: these results do not measure the whole web.

coverage_scopestring required
verification_viewstring required
max_retrieval_skew_msnumber required
selected_inventory_idsstring[] required
unselected_member_idsstring[] required
baseline_report_hashstring required
preview_hashstring required
dry_runtrue required
per_rule_counts_overlapboolean required
examples_truncatedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.