> ## Documentation Index
> Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Scan Results

Use this API to retrieve results for a specific scan, including details such as cookies, tags, forms, etc.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Consent & Preferences - Cookie Consent",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Cookie Consent APIs are used to integrate external systems and streamline the flow of data with Cookie Consent in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Scans",
      "description": "The Scans APIs are used to manage website cookie scanning operations and results.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/scanresults": {
      "get": {
        "operationId": "getDetailedScanResultInformation",
        "summary": "Get Scan Results",
        "description": "Use this API to retrieve results for a specific scan, including details such as cookies, tags, forms, etc.",
        "tags": [
          "Scans"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"
        },
        "parameters": [
          {
            "name": "domainId",
            "in": "path",
            "description": "The unique identifier of the domain.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          {
            "name": "scanId",
            "in": "path",
            "description": "The unique identifier of the scan.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          {
            "name": "language",
            "in": "query",
            "description": "The language code for localized content.",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 5,
              "minLength": 2
            },
            "example": "en"
          },
          {
            "name": "countryCode",
            "in": "query",
            "description": "The country code for regional settings.",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 2,
              "minLength": 2
            },
            "example": "us"
          },
          {
            "name": "entityType",
            "in": "query",
            "description": "The type of entity such as cookie, tag, page, form, service, or storage.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "COOKIE",
                "TAG",
                "PAGE",
                "FORM",
                "SERVICE",
                "STORAGE"
              ]
            },
            "example": "COOKIE"
          },
          {
            "name": "page",
            "in": "query",
            "description": "The page number for pagination results, starting from 0.",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 1,
              "default": 0,
              "minimum": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of items to return per page.",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 10,
              "default": 10,
              "maximum": 100,
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns detailed scan results.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScanResultEntityPageResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "OAUTH2": [
              "COOKIE",
              "COOKIE_READ"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "CookieInformationDetailed": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Cookie identifier",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "Cookie name",
            "type": "string",
            "example": "snn_id"
          },
          "host": {
            "description": "Host associated with the cookie",
            "type": "string",
            "example": "amazon.com"
          },
          "expiryDate": {
            "description": "Expiry date of the cookie",
            "type": "integer",
            "format": "int32"
          },
          "expiryUnit": {
            "description": "Expiry unit of the cookie.",
            "type": "string",
            "example": "WEEK",
            "enum": [
              "DAY",
              "WEEK",
              "MONTH",
              "YEAR"
            ]
          },
          "urlDomain": {
            "description": "Domain url",
            "type": "string",
            "example": "amazon.com"
          },
          "path": {
            "description": "Cookie path",
            "type": "string",
            "example": "/"
          },
          "isSecure": {
            "description": "Whether cookie is secure",
            "type": "boolean",
            "example": true
          },
          "isHttpOnly": {
            "description": "Whether cookie is http only",
            "type": "boolean",
            "example": true
          },
          "isSession": {
            "description": "Whether cookie is a session cookie",
            "type": "boolean",
            "example": true
          },
          "isBehindLogin": {
            "description": "Whether cookie is behind login",
            "type": "boolean",
            "example": true
          },
          "hostDescription": {
            "description": "Host description",
            "type": "string",
            "example": "Amazon is a website"
          },
          "thirdPartyDescription": {
            "description": "Third party description",
            "type": "string",
            "example": "This cookie is used for advertising"
          },
          "description": {
            "description": "Cookie description",
            "type": "string",
            "example": "This cookie is used for advertising"
          },
          "purpose": {
            "description": "Cookie purpose",
            "type": "string",
            "example": "This cookie is used for advertising"
          },
          "cookiepediaCategory": {
            "description": "Cookie category name",
            "type": "string",
            "example": "Targeting"
          },
          "firstParty": {
            "description": "Whether cookies is first party",
            "type": "boolean",
            "example": true
          },
          "status": {
            "description": "Cookie status.",
            "type": "string",
            "example": "NOT_FOUND",
            "enum": [
              "NEW",
              "REVIEWED",
              "NOT_FOUND",
              "DELETED",
              "REVIEWED_NOT_FOUND"
            ]
          },
          "color": {
            "description": "Cookie color related to the category.",
            "type": "string",
            "example": "red"
          },
          "isNewFound": {
            "description": "Whether cookie is new found from this scan.",
            "type": "boolean",
            "example": true
          },
          "isNewlyAdded": {
            "description": "Whether cookie is newly added from this scan.",
            "type": "boolean",
            "example": true
          },
          "categoryId": {
            "description": "Cookie category identifier.",
            "type": "string",
            "example": "C0001"
          }
        }
      },
      "PageDto": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Page identifier",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "auditUrl": {
            "description": "Page url",
            "type": "string",
            "example": "https://abcnews.go.com/"
          },
          "cookieCount": {
            "description": "Number of cookies found on page",
            "type": "integer",
            "format": "int64",
            "example": 33
          },
          "errorMessage": {
            "description": "Error message if something went wrong when scanning page.",
            "type": "string",
            "example": 33
          },
          "sourceUrl": {
            "description": "Source url.",
            "type": "string",
            "example": "https://abcnews.go.com/"
          },
          "scanOrder": {
            "description": "Source url.",
            "type": "integer",
            "format": "int32",
            "example": "https://abcnews.go.com/"
          },
          "isCookiePolicy": {
            "type": "number",
            "format": "double"
          },
          "isPrivacyPolicy": {
            "type": "number",
            "format": "double"
          },
          "isLoginForm": {
            "description": "Whether page has login form.",
            "type": "boolean",
            "example": false
          },
          "isBehindLogin": {
            "description": "Whether page is behind login.",
            "type": "boolean",
            "example": false
          },
          "hasVideo": {
            "description": "Whether the page has video content ",
            "type": "boolean",
            "example": false
          }
        }
      },
      "TagDto": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Tag identifier",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "host": {
            "description": "Tag host",
            "type": "string",
            "example": "abcnews.com"
          },
          "tagType": {
            "description": "Tag type",
            "type": "string",
            "example": "Script"
          },
          "src": {
            "description": "Tag source url",
            "type": "string",
            "example": "Script"
          },
          "params": {
            "description": "Tag parameters.",
            "type": "string",
            "example": "(720px 893px)"
          },
          "createdDate": {
            "description": "Date when the tag was created.",
            "type": "string",
            "format": "date-time",
            "example": "2025-04-25T12:34:32Z"
          },
          "status": {
            "description": "Tag status. Can be 1 or 2 (new or not found)",
            "type": "integer",
            "format": "int32",
            "example": "Script"
          },
          "age": {
            "description": "How many days the tag is old.",
            "type": "integer",
            "format": "int32",
            "example": 133
          },
          "parent": {
            "description": "Tag parent url.",
            "type": "string",
            "example": "amazon.com"
          },
          "children": {
            "description": "Tag child url.",
            "type": "string",
            "example": "amazon.com"
          },
          "firstParty": {
            "description": "Whether tag is first party",
            "type": "boolean",
            "example": true
          },
          "added": {
            "description": "Whether the tag was added since previous scan",
            "type": "boolean",
            "example": true
          },
          "removed": {
            "description": "Whether the tag was removed since previous scan",
            "type": "boolean",
            "example": false
          },
          "changeSincePreviousScan": {
            "description": "Changes in comparison to previous successful scan.",
            "type": "string",
            "example": "Added since previous scan (Feb 24, 2025 08:11 AM)"
          }
        }
      },
      "FormDataDto": {
        "type": "object",
        "properties": {
          "fieldName": {
            "description": "Field name",
            "type": "string",
            "example": "username"
          },
          "formName": {
            "description": "Name of the form to which this field belongs",
            "type": "string",
            "example": "loginForm"
          },
          "type": {
            "description": "Type of data field. For example email/text/hidden.",
            "type": "string",
            "example": "text"
          },
          "title": {
            "description": "Field title",
            "type": "string",
            "example": "Username"
          },
          "label": {
            "description": "Field lable",
            "type": "string",
            "example": "E-mail"
          },
          "value": {
            "description": "Value of the field. Mostly this value is empty since the fields expect some input.",
            "type": "string",
            "example": "value123"
          },
          "personalData": {
            "type": "boolean"
          }
        }
      },
      "FormDataGroupDto": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Form identifier",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "Form name",
            "type": "string",
            "example": "formdatagroupname"
          },
          "numberOfPagesFound": {
            "description": "Number of pages where this form was found",
            "type": "integer",
            "format": "int64",
            "example": 3
          },
          "formDataFields": {
            "description": "List of data field information contained in the form",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FormDataDto"
            }
          }
        }
      },
      "StorageEntriesDto": {
        "type": "object",
        "properties": {
          "host": {
            "description": "Storage entry host",
            "type": "string",
            "example": "https://abcnews.go.com"
          },
          "key": {
            "description": "Storage entry key",
            "type": "string",
            "example": "abcnews314-volume"
          },
          "value": {
            "description": "Storage entry value",
            "type": "string"
          },
          "type": {
            "description": "Storage entry type. Can be 1 or 2 (local or session)",
            "type": "integer",
            "format": "int32",
            "example": "abcnews314-volume"
          }
        }
      },
      "ServiceProviderBasicDetails": {
        "type": "object",
        "properties": {
          "serviceName": {
            "description": "Service name",
            "type": "string",
            "example": "Adobe Marketing Cloud"
          },
          "vendor": {
            "description": "Vendor name",
            "type": "string",
            "example": "Adobe"
          },
          "category": {
            "description": "Category",
            "type": "string",
            "example": "Performance Cookies"
          },
          "description": {
            "description": "Service description",
            "type": "string",
            "example": "Adobe Marketing Cloud gives customers the most complete set of integrated digital marketing solutions available."
          },
          "location": {
            "description": "Address",
            "type": "string",
            "example": 345
          },
          "privacyPolicy": {
            "description": "Privacy policy url",
            "type": "string",
            "example": "https://www.adobe.com/privacy/policy.html"
          },
          "added": {
            "description": "Whether the service was added since previous scan",
            "type": "boolean",
            "example": true
          },
          "removed": {
            "description": "Whether the service was removed since previous scan",
            "type": "boolean",
            "example": false
          },
          "changeSincePreviousScan": {
            "description": "Changes in comparison to previous successful scan.",
            "type": "string",
            "example": "Added since previous scan (Feb 24, 2025 08:11 AM)"
          }
        }
      },
      "ScanResultEntityPageResponse": {
        "type": "object",
        "properties": {
          "content": {
            "description": "The main content or data payload of the response.",
            "example": [
              {
                "cookieId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
                "cookieName": "session_id",
                "host": "example.com"
              }
            ],
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/CookieInformationDetailed"
                },
                {
                  "$ref": "#/components/schemas/PageDto"
                },
                {
                  "$ref": "#/components/schemas/TagDto"
                },
                {
                  "$ref": "#/components/schemas/FormDataGroupDto"
                },
                {
                  "$ref": "#/components/schemas/StorageEntriesDto"
                },
                {
                  "$ref": "#/components/schemas/ServiceProviderBasicDetails"
                }
              ]
            },
            "maxItems": 2000,
            "minItems": 0,
            "type": "array"
          },
          "scanId": {
            "description": "Scan ID",
            "type": "string",
            "format": "uuid",
            "example": "123e4567-e89b-12d3-a456-426614174000"
          },
          "domainId": {
            "description": "The unique identifier of the domain.",
            "type": "string",
            "format": "uuid",
            "example": "123e4567-e89b-12d3-a456-426614174000"
          },
          "totalElements": {
            "description": "The total number of items in the complete result set.",
            "type": "integer",
            "format": "int64",
            "example": 100
          },
          "totalPages": {
            "description": "The total number of pages in the paginated results.",
            "type": "integer",
            "format": "int32",
            "example": 99
          },
          "pageSize": {
            "description": "The number of items displayed per page.",
            "type": "integer",
            "format": "int32",
            "example": 5
          },
          "pageNumber": {
            "description": "The current page number in the pagination sequence.",
            "type": "integer",
            "format": "int32",
            "example": 1
          },
          "numberOfElements": {
            "description": "The number of items in the current page.",
            "type": "integer",
            "format": "int32",
            "example": 5
          }
        }
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "COOKIE": "Cookie Scope gives the user access to read/write operations inside the Cookie Consent module.",
              "COOKIE_READ": "Cookie Read Scope gives the user read-only access to the Cookie Consent module."
            }
          }
        }
      }
    }
  }
}
```