CDPConsentExperimentationGuidesSupport

Web Scanners

Manage web scanners that crawl your sites for trackers, cookies, and third-party requests. Create a scanner against a root domain, edit its crawl scope, trigger a scan on demand, or delete it (which also removes its suppression rules).

Manage web scanners that crawl your sites for trackers, cookies, and third-party requests. Create a scanner against a root domain, edit its crawl scope, trigger a scan on demand, or delete it (which also removes its suppression rules).

GET
/rest/v1/web-scanners

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanners"
{
  "entities": [
    {
      "id": "string",
      "accountId": "string",
      "name": "string",
      "status": "Disabled",
      "rootDomain": "string",
      "excludedPatterns": [
        "string"
      ],
      "includedUrls": [
        "string"
      ],
      "urlLimit": 0,
      "scanStatus": "idle",
      "lastScannedAt": "string",
      "lastScanStartedAt": "string",
      "lastRunCookieCount": 0,
      "lastRunRequestCount": 0,
      "lastRunSuccessUrlCount": 0,
      "lastRunHighRiskRequestCount": 0,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
POST
/rest/v1/web-scanners
*object

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.oursprivacy.com/rest/v1/web-scanners" \  -H "Content-Type: application/json" \  -d '{    "rootDomain": "string"  }'
{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/web-scanners/{id}

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanners/string"
{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
PATCH
/rest/v1/web-scanners/{id}
*object

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.oursprivacy.com/rest/v1/web-scanners/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
DELETE
/rest/v1/web-scanners/{id}

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.oursprivacy.com/rest/v1/web-scanners/string"
{
  "id": "string",
  "deleted": true
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
POST
/rest/v1/web-scanners/{id}/trigger

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.oursprivacy.com/rest/v1/web-scanners/string/trigger"
{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "status": "Disabled",
  "rootDomain": "string",
  "excludedPatterns": [
    "string"
  ],
  "includedUrls": [
    "string"
  ],
  "urlLimit": 0,
  "scanStatus": "idle",
  "lastScannedAt": "string",
  "lastScanStartedAt": "string",
  "lastRunCookieCount": 0,
  "lastRunRequestCount": 0,
  "lastRunSuccessUrlCount": 0,
  "lastRunHighRiskRequestCount": 0,
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/web-scanners/{id}/findings

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

date?string

Which scan run to read, as an ISO-8601 timestamp. Only the UTC calendar day is used to select the run; the time component is ignored. Defaults to the most recent run when omitted.

Formatdate-time
limit?integer

Maximum number of findings to return. Defaults to 25; clamped to 1–100.

Range1 <= value <= 100
offset?|

Skip this many findings before returning. Use with limit for load-more paging.

Range0 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanners/string/findings"
{
  "items": [
    {
      "hostname": "string",
      "urls": [
        "string"
      ],
      "types": [
        "audio"
      ],
      "cookies": [
        {
          "name": "string",
          "value": "string",
          "domain": "string",
          "path": "string"
        }
      ],
      "seenOn": [
        "string"
      ],
      "privacyKeywords": [
        "string"
      ],
      "risk": "string",
      "category": "string",
      "displayName": "string",
      "coveredByCmp": true,
      "coveredByVendorLabel": "string"
    }
  ],
  "total": 0,
  "hasMore": true
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/web-scanners/{id}/cookies

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

date?string

Which scan run to read, as an ISO-8601 timestamp. Only the UTC calendar day is used to select the run; the time component is ignored. Defaults to the most recent run when omitted.

Formatdate-time
limit?integer

Maximum number of findings to return. Defaults to 25; clamped to 1–100.

Range1 <= value <= 100
offset?|

Skip this many findings before returning. Use with limit for load-more paging.

Range0 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanners/string/cookies"
{
  "cookies": [
    {
      "name": "string",
      "value": "string",
      "domain": "string",
      "path": "string"
    }
  ],
  "localStorage": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "totalCookies": 0,
  "totalLocalStorage": 0,
  "hasMore": true
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/web-scanners/{id}/summary

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

date?string

Which scan run to read, as an ISO-8601 timestamp. Only the UTC calendar day is used to select the run; the time component is ignored. Defaults to the most recent run when omitted.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.oursprivacy.com/rest/v1/web-scanners/string/summary"
{
  "scannerId": "string",
  "rootDomain": "string",
  "scanStatus": "idle",
  "runDate": "string",
  "hostCount": 0,
  "vendorCount": 0,
  "cookieCount": 0,
  "localStorageCount": 0,
  "countsByRisk": {
    "high": 0,
    "medium": 0,
    "low": 0,
    "unknown": 0
  },
  "byCategory": [
    {
      "category": "string",
      "hostCount": 0
    }
  ],
  "coverage": {
    "totalHostCount": 0,
    "coveredHostCount": 0,
    "needsDecisionHostCount": 0,
    "coveragePercent": 0
  },
  "delta": {
    "newHostCount": 0,
    "removedHostCount": 0
  },
  "topUncoveredHosts": [
    {
      "hostname": "string",
      "urls": [
        "string"
      ],
      "types": [
        "audio"
      ],
      "cookies": [
        {
          "name": "string",
          "value": "string",
          "domain": "string",
          "path": "string"
        }
      ],
      "seenOn": [
        "string"
      ],
      "privacyKeywords": [
        "string"
      ],
      "risk": "string",
      "category": "string",
      "displayName": "string",
      "coveredByCmp": true,
      "coveredByVendorLabel": "string"
    }
  ],
  "accessibility": {
    "engine": "string",
    "score": 0,
    "pagesEvaluated": 0,
    "totalViolations": 0,
    "totalNodes": 0,
    "countsByImpact": {
      "critical": 0,
      "serious": 0,
      "moderate": 0,
      "minor": 0
    },
    "topViolations": [
      {
        "id": "string",
        "impact": "string",
        "help": "string",
        "helpUrl": "string",
        "wcagTags": [
          "string"
        ],
        "pageCount": 0,
        "nodeCount": 0,
        "pages": [
          "string"
        ],
        "sampleNodes": [
          {
            "target": [
              "string"
            ],
            "html": "string",
            "failureSummary": "string"
          }
        ]
      }
    ]
  }
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}

How is this guide?

Session Replay Settings

Previous Page

Web Scanner Rules

Next Page