ONonetrust
Scans

Get Scan Result Summary

Use this API to retrieve summary information for a scan, including counts of cookies, tags, forms, and other entities found.

get/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/summary

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/summary
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: COOKIE, COOKIE_READ

Path parameters

domainIdstring uuid required

The unique identifier of the domain.

scanIdstring uuid required

The unique identifier of the scan.

Query parameters

languagestring

The language code for localized content.

countryCodestring

The country code for regional settings.

Response

OK

scannedPageUrlsstring[]

URL of all the pages scanned

numTagsinteger

Number of tags associated with this scan.

numCookiesinteger

Number of cookies associated with this scan.

numCookiesByCategoryobject

Number of cookies associated with this scan, grouped by cookiepedia category.

Example response

{
  "scannedPageUrls": [
    "onetrust.com",
    "onetrust.com/robots.txt"
  ],
  "numTags": 25,
  "numCookies": 150
}

Changes

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