Audits Domain
Audits domain allows investigation of page violations and possible improvements.
Methods
Events
Types
Methods
Audits.checkContrast #
Runs the contrast check for the target page. Found issues are reported using Audits.issueAdded event.
parameters
- reportAAA
- boolean
Whether to report WCAG AAA level issues. Default is false.
Audits.checkFormsIssues #
Runs the form issues check for the target page. Found issues are reported using Audits.issueAdded event.
Return Object
- formIssues
- array[ GenericIssueDetails ]
Audits.disable #
Disables issues domain, prevents further issues from being reported to the client.
Audits.enable #
Enables issues domain, sends the issues collected so far to the client by means of the issueAdded event.
Audits.getEncodedResponse #
Returns the response body and size if it were re-encoded with the specified settings. Only applies to images.
parameters
- requestId
- Network.RequestId
Identifier of the network request to get content for.
- encoding
- string
The encoding to use.
Allowed Values:webp,jpeg,png - quality
- number
The quality of the encoding (0-1). (defaults to 1)
- sizeOnly
- boolean
Whether to only return the size information (defaults to false).
Return Object
- body
- string
The encoded body as a base64 string. Omitted if sizeOnly is true. (Encoded as a base64 string when passed over JSON)
- originalSize
- integer
Size before re-encoding.
- encodedSize
- integer
Size after re-encoding.
Events
Types
Audits.AffectedCookie #
Information about a cookie that is affected by an inspector issue.
Type: object
properties
- name
- string
The following three properties uniquely identify a cookie
- path
- string
- domain
- string
Audits.AffectedFrame #
Information about the frame affected by an inspector issue.
Type: object
properties
- frameId
- Page.FrameId
Audits.AffectedRequest #
Information about a request that is affected by an inspector issue.
Type: object
properties
- requestId
- Network.RequestId
The unique request id.
- url
- string
Audits.AttributionReportingIssueDetails #
Details for issues around "Attribution Reporting API" usage. Explainer: https://github.com/WICG/attribution-reporting-api
Type: object
properties
- violationType
- AttributionReportingIssueType
- request
- AffectedRequest
- violatingNodeId
- DOM.BackendNodeId
- invalidParameter
- string
Audits.AttributionReportingIssueType #
PermissionPolicyDisabled, UntrustworthyReportingOrigin, InsecureContext, InvalidHeader, InvalidRegisterTriggerHeader, SourceAndTriggerHeaders, SourceIgnored, TriggerIgnored, OsSourceIgnored, OsTriggerIgnored, InvalidRegisterOsSourceHeader, InvalidRegisterOsTriggerHeader, WebAndOsHeaders, NoWebOrOsSupport, NavigationRegistrationWithoutTransientUserActivation, InvalidInfoHeader, NoRegisterSourceHeader, NoRegisterTriggerHeader, NoRegisterOsSourceHeader, NoRegisterOsTriggerHeader, NavigationRegistrationUniqueScopeAlreadySetType: string
Audits.BlockedByResponseIssueDetails #
Details for a request that has been blocked with the BLOCKED_BY_RESPONSE code. Currently only used for COEP/COOP, but may be extended to include some CSP errors in the future.
Type: object
properties
- request
- AffectedRequest
- parentFrame
- AffectedFrame
- blockedFrame
- AffectedFrame
- reason
- BlockedByResponseReason
Audits.BlockedByResponseReason #
Enum indicating the reason a response has been blocked. These reasons are refinements of the net error BLOCKED_BY_RESPONSE.
CoepFrameResourceNeedsCoepHeader, CoopSandboxedIFrameCannotNavigateToCoopPage, CorpNotSameOrigin, CorpNotSameOriginAfterDefaultedToSameOriginByCoep, CorpNotSameOriginAfterDefaultedToSameOriginByDip, CorpNotSameOriginAfterDefaultedToSameOriginByCoepAndDip, CorpNotSameSite, SRIMessageSignatureMismatchType: string
Audits.BounceTrackingIssueDetails #
This issue warns about sites in the redirect chain of a finished navigation that may be flagged as trackers and have their state cleared if they don't receive a user interaction. Note that in this context 'site' means eTLD+1. For example, if the URL https://example.test:80/bounce was in the redirect chain, the site reported would be example.test.
Type: object
properties
- trackingSites
- array[ string ]
Audits.ClientHintIssueDetails #
This issue tracks client hints related issues. It's used to deprecate old features, encourage the use of new ones, and provide general guidance.
Type: object
properties
- sourceCodeLocation
- SourceCodeLocation
- clientHintIssueReason
- ClientHintIssueReason
Audits.ClientHintIssueReason #
MetaTagAllowListInvalidOrigin, MetaTagModifiedHTMLType: string
Audits.ContentSecurityPolicyIssueDetails #
Type: object
properties
- blockedURL
- string
The url not included in allowed sources.
- violatedDirective
- string
Specific directive that is violated, causing the CSP issue.
- isReportOnly
- boolean
- contentSecurityPolicyViolationType
- ContentSecurityPolicyViolationType
- frameAncestor
- AffectedFrame
- sourceCodeLocation
- SourceCodeLocation
- violatingNodeId
- DOM.BackendNodeId
Audits.ContentSecurityPolicyViolationType #
kInlineViolation, kEvalViolation, kURLViolation, kSRIViolation, kTrustedTypesSinkViolation, kTrustedTypesPolicyViolation, kWasmEvalViolationType: string
Audits.CookieDeprecationMetadataIssueDetails #
This issue warns about third-party sites that are accessing cookies on the current page, and have been permitted due to having a global metadata grant. Note that in this context 'site' means eTLD+1. For example, if the URL https://example.test:80/web_page was accessing cookies, the site reported would be example.test.
Type: object
properties
- allowedSites
- array[ string ]
- optOutPercentage
- number
- isOptOutTopLevel
- boolean
- operation
- CookieOperation
Audits.CookieExclusionReason #
ExcludeSameSiteUnspecifiedTreatedAsLax, ExcludeSameSiteNoneInsecure, ExcludeSameSiteLax, ExcludeSameSiteStrict, ExcludeInvalidSameParty, ExcludeSamePartyCrossPartyContext, ExcludeDomainNonASCII, ExcludeThirdPartyCookieBlockedInFirstPartySet, ExcludeThirdPartyPhaseout, ExcludePortMismatch, ExcludeSchemeMismatchType: string
Audits.CookieIssueDetails #
This information is currently necessary, as the front-end has a difficult time finding a specific cookie. With this, we can convey specific error information without the cookie.
Type: object
properties
- cookie
- AffectedCookie
If AffectedCookie is not set then rawCookieLine contains the raw Set-Cookie header string. This hints at a problem where the cookie line is syntactically or semantically malformed in a way that no valid cookie could be created.
- rawCookieLine
- string
- cookieWarningReasons
- array[ CookieWarningReason ]
- cookieExclusionReasons
- array[ CookieExclusionReason ]
- operation
- CookieOperation
Optionally identifies the site-for-cookies and the cookie url, which may be used by the front-end as additional context.
- siteForCookies
- string
- cookieUrl
- string
- request
- AffectedRequest
- insight
- CookieIssueInsight
The recommended solution to the issue.
Audits.CookieIssueInsight #
Information about the suggested solution to a cookie issue.
Type: object
properties
- type
- InsightType
- tableEntryUrl
- string
Link to table entry in third-party cookie migration readiness list.
Audits.CookieWarningReason #
WarnSameSiteUnspecifiedCrossSiteContext, WarnSameSiteNoneInsecure, WarnSameSiteUnspecifiedLaxAllowUnsafe, WarnSameSiteStrictLaxDowngradeStrict, WarnSameSiteStrictCrossDowngradeStrict, WarnSameSiteStrictCrossDowngradeLax, WarnSameSiteLaxCrossDowngradeStrict, WarnSameSiteLaxCrossDowngradeLax, WarnAttributeValueExceedsMaxSize, WarnDomainNonASCII, WarnThirdPartyPhaseout, WarnCrossSiteRedirectDowngradeChangesInclusion, WarnDeprecationTrialMetadata, WarnThirdPartyCookieHeuristicType: string
Audits.CorsIssueDetails #
Details for a CORS related issue, e.g. a warning or error related to CORS RFC1918 enforcement.
Type: object
properties
- corsErrorStatus
- Network.CorsErrorStatus
- isWarning
- boolean
- request
- AffectedRequest
- location
- SourceCodeLocation
- initiatorOrigin
- string
- resourceIPAddressSpace
- Network.IPAddressSpace
- clientSecurityState
- Network.ClientSecurityState
Audits.DeprecationIssueDetails #
This issue tracks information needed to print a deprecation message. https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md
Type: object
properties
- affectedFrame
- AffectedFrame
- sourceCodeLocation
- SourceCodeLocation
- type
- string
One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5
Audits.ElementAccessibilityIssueDetails #
This issue warns about errors in the select or summary element content model.
Type: object
properties
- nodeId
- DOM.BackendNodeId
- elementAccessibilityIssueReason
- ElementAccessibilityIssueReason
- hasDisallowedAttributes
- boolean
Audits.ElementAccessibilityIssueReason #
DisallowedSelectChild, DisallowedOptGroupChild, NonPhrasingContentOptionChild, InteractiveContentOptionChild, InteractiveContentLegendChild, InteractiveContentSummaryDescendantType: string
Audits.FailedRequestInfo #
Type: object
properties
- url
- string
The URL that failed to load.
- failureMessage
- string
The failure message for the failed request.
- requestId
- Network.RequestId
Audits.FederatedAuthRequestIssueDetails #
Type: object
properties
- federatedAuthRequestIssueReason
- FederatedAuthRequestIssueReason
Audits.FederatedAuthRequestIssueReason #
Represents the failure reason when a federated authentication reason fails. Should be updated alongside RequestIdTokenStatus in third_party/blink/public/mojom/devtools/inspector_issue.mojom to include all cases except for success.
ShouldEmbargo, TooManyRequests, WellKnownHttpNotFound, WellKnownNoResponse, WellKnownInvalidResponse, WellKnownListEmpty, WellKnownInvalidContentType, ConfigNotInWellKnown, WellKnownTooBig, ConfigHttpNotFound, ConfigNoResponse, ConfigInvalidResponse, ConfigInvalidContentType, ClientMetadataHttpNotFound, ClientMetadataNoResponse, ClientMetadataInvalidResponse, ClientMetadataInvalidContentType, IdpNotPotentiallyTrustworthy, DisabledInSettings, DisabledInFlags, ErrorFetchingSignin, InvalidSigninResponse, AccountsHttpNotFound, AccountsNoResponse, AccountsInvalidResponse, AccountsListEmpty, AccountsInvalidContentType, IdTokenHttpNotFound, IdTokenNoResponse, IdTokenInvalidResponse, IdTokenIdpErrorResponse, IdTokenCrossSiteIdpErrorResponse, IdTokenInvalidRequest, IdTokenInvalidContentType, ErrorIdToken, Canceled, RpPageNotVisible, SilentMediationFailure, ThirdPartyCookiesBlocked, NotSignedInWithIdp, MissingTransientUserActivation, ReplacedByActiveMode, InvalidFieldsSpecified, RelyingPartyOriginIsOpaque, TypeNotMatching, UiDismissedNoEmbargo, CorsError, SuppressedBySegmentationPlatformType: string
Audits.FederatedAuthUserInfoRequestIssueDetails #
Type: object
properties
- federatedAuthUserInfoRequestIssueReason
- FederatedAuthUserInfoRequestIssueReason
Audits.FederatedAuthUserInfoRequestIssueReason #
Represents the failure reason when a getUserInfo() call fails. Should be updated alongside FederatedAuthUserInfoRequestResult in third_party/blink/public/mojom/devtools/inspector_issue.mojom.
NotSameOrigin, NotIframe, NotPotentiallyTrustworthy, NoApiPermission, NotSignedInWithIdp, NoAccountSharingPermission, InvalidConfigOrWellKnown, InvalidAccountsResponse, NoReturningUserFromFetchedAccountsType: string
Audits.GenericIssueDetails #
Depending on the concrete errorType, different properties are set.
Type: object
properties
- errorType
- GenericIssueErrorType
Issues with the same errorType are aggregated in the frontend.
- frameId
- Page.FrameId
- violatingNodeId
- DOM.BackendNodeId
- violatingNodeAttribute
- string
- request
- AffectedRequest
Audits.GenericIssueErrorType #
FormLabelForNameError, FormDuplicateIdForInputError, FormInputWithNoLabelError, FormAutocompleteAttributeEmptyError, FormEmptyIdAndNameAttributesForInputError, FormAriaLabelledByToNonExistingId, FormInputAssignedAutocompleteValueToIdOrNameAttributeError, FormLabelHasNeitherForNorNestedInput, FormLabelForMatchesNonExistingIdError, FormInputHasWrongButWellIntendedAutocompleteValueError, ResponseWasBlockedByORBType: string
Audits.HeavyAdIssueDetails #
Type: object
properties
- resolution
- HeavyAdResolutionStatus
The resolution status, either blocking the content or warning.
- reason
- HeavyAdReason
The reason the ad was blocked, total network or cpu or peak cpu.
- frame
- AffectedFrame
The frame that was blocked.
Audits.InsightType #
Represents the category of insight that a cookie issue falls under.
GitHubResource, GracePeriod, HeuristicsType: string
Audits.InspectorIssue #
An inspector issue reported from the back-end.
Type: object
properties
- code
- InspectorIssueCode
- details
- InspectorIssueDetails
- issueId
- IssueId
A unique id for this issue. May be omitted if no other entity (e.g. exception, CDP message, etc.) is referencing this issue.
Audits.InspectorIssueCode #
A unique identifier for the type of issue. Each type may use one of the optional fields in InspectorIssueDetails to convey more specific information about the kind of issue.
CookieIssue, MixedContentIssue, BlockedByResponseIssue, HeavyAdIssue, ContentSecurityPolicyIssue, SharedArrayBufferIssue, LowTextContrastIssue, CorsIssue, AttributionReportingIssue, QuirksModeIssue, PartitioningBlobURLIssue, NavigatorUserAgentIssue, GenericIssue, DeprecationIssue, ClientHintIssue, FederatedAuthRequestIssue, BounceTrackingIssue, CookieDeprecationMetadataIssue, StylesheetLoadingIssue, FederatedAuthUserInfoRequestIssue, PropertyRuleIssue, SharedDictionaryIssue, ElementAccessibilityIssue, SRIMessageSignatureIssue, UnencodedDigestIssue, UserReidentificationIssueType: string
Audits.InspectorIssueDetails #
This struct holds a list of optional fields with additional information specific to the kind of issue. When adding a new issue code, please also add a new optional field to this type.
Type: object
properties
- cookieIssueDetails
- CookieIssueDetails
- mixedContentIssueDetails
- MixedContentIssueDetails
- blockedByResponseIssueDetails
- BlockedByResponseIssueDetails
- heavyAdIssueDetails
- HeavyAdIssueDetails
- contentSecurityPolicyIssueDetails
- ContentSecurityPolicyIssueDetails
- sharedArrayBufferIssueDetails
- SharedArrayBufferIssueDetails
- lowTextContrastIssueDetails
- LowTextContrastIssueDetails
- corsIssueDetails
- CorsIssueDetails
- attributionReportingIssueDetails
- AttributionReportingIssueDetails
- quirksModeIssueDetails
- QuirksModeIssueDetails
- partitioningBlobURLIssueDetails
- PartitioningBlobURLIssueDetails
- navigatorUserAgentIssueDetails
- NavigatorUserAgentIssueDetails Deprecated
- genericIssueDetails
- GenericIssueDetails
- deprecationIssueDetails
- DeprecationIssueDetails
- clientHintIssueDetails
- ClientHintIssueDetails
- federatedAuthRequestIssueDetails
- FederatedAuthRequestIssueDetails
- bounceTrackingIssueDetails
- BounceTrackingIssueDetails
- cookieDeprecationMetadataIssueDetails
- CookieDeprecationMetadataIssueDetails
- stylesheetLoadingIssueDetails
- StylesheetLoadingIssueDetails
- propertyRuleIssueDetails
- PropertyRuleIssueDetails
- federatedAuthUserInfoRequestIssueDetails
- FederatedAuthUserInfoRequestIssueDetails
- sharedDictionaryIssueDetails
- SharedDictionaryIssueDetails
- elementAccessibilityIssueDetails
- ElementAccessibilityIssueDetails
- sriMessageSignatureIssueDetails
- SRIMessageSignatureIssueDetails
- unencodedDigestIssueDetails
- UnencodedDigestIssueDetails
- userReidentificationIssueDetails
- UserReidentificationIssueDetails
Audits.IssueId #
A unique id for a DevTools inspector issue. Allows other entities (e.g. exceptions, CDP message, console messages, etc.) to reference an issue.
Type: string
Audits.LowTextContrastIssueDetails #
Type: object
properties
- violatingNodeId
- DOM.BackendNodeId
- violatingNodeSelector
- string
- contrastRatio
- number
- thresholdAA
- number
- thresholdAAA
- number
- fontSize
- string
- fontWeight
- string
Audits.MixedContentIssueDetails #
Type: object
properties
- resourceType
- MixedContentResourceType
The type of resource causing the mixed content issue (css, js, iframe, form,...). Marked as optional because it is mapped to from blink::mojom::RequestContextType, which will be replaced by network::mojom::RequestDestination
- resolutionStatus
- MixedContentResolutionStatus
The way the mixed content issue is being resolved.
- insecureURL
- string
The unsafe http url causing the mixed content issue.
- mainResourceURL
- string
The url responsible for the call to an unsafe url.
- request
- AffectedRequest
The mixed content request. Does not always exist (e.g. for unsafe form submission urls).
- frame
- AffectedFrame
Optional because not every mixed content issue is necessarily linked to a frame.
Audits.MixedContentResolutionStatus #
MixedContentBlocked, MixedContentAutomaticallyUpgraded, MixedContentWarningType: string
Audits.MixedContentResourceType #
AttributionSrc, Audio, Beacon, CSPReport, Download, EventSource, Favicon, Font, Form, Frame, Image, Import, JSON, Manifest, Ping, PluginData, PluginResource, Prefetch, Resource, Script, ServiceWorker, SharedWorker, SpeculationRules, Stylesheet, Track, Video, Worker, XMLHttpRequest, XSLTType: string
Audits.PartitioningBlobURLInfo #
BlockedCrossPartitionFetching, EnforceNoopenerForNavigationType: string
Audits.PartitioningBlobURLIssueDetails #
Type: object
properties
- url
- string
The BlobURL that failed to load.
- partitioningBlobURLInfo
- PartitioningBlobURLInfo
Additional information about the Partitioning Blob URL issue.
Audits.PropertyRuleIssueDetails #
This issue warns about errors in property rules that lead to property registrations being ignored.
Type: object
properties
- sourceCodeLocation
- SourceCodeLocation
Source code position of the property rule.
- propertyRuleIssueReason
- PropertyRuleIssueReason
Reason why the property rule was discarded.
- propertyValue
- string
The value of the property rule property that failed to parse
Audits.PropertyRuleIssueReason #
InvalidSyntax, InvalidInitialValue, InvalidInherits, InvalidNameType: string
Audits.QuirksModeIssueDetails #
Details for issues about documents in Quirks Mode or Limited Quirks Mode that affects page layouting.
Type: object
properties
- isLimitedQuirksMode
- boolean
If false, it means the document's mode is "quirks" instead of "limited-quirks".
- documentNodeId
- DOM.BackendNodeId
- url
- string
- frameId
- Page.FrameId
- loaderId
- Network.LoaderId
Audits.SharedArrayBufferIssueDetails #
Details for a issue arising from an SAB being instantiated in, or transferred to a context that is not cross-origin isolated.
Type: object
properties
- sourceCodeLocation
- SourceCodeLocation
- isWarning
- boolean
- type
- SharedArrayBufferIssueType
Audits.SharedDictionaryError #
UseErrorCrossOriginNoCorsRequest, UseErrorDictionaryLoadFailure, UseErrorMatchingDictionaryNotUsed, UseErrorUnexpectedContentDictionaryHeader, WriteErrorCossOriginNoCorsRequest, WriteErrorDisallowedBySettings, WriteErrorExpiredResponse, WriteErrorFeatureDisabled, WriteErrorInsufficientResources, WriteErrorInvalidMatchField, WriteErrorInvalidStructuredHeader, WriteErrorInvalidTTLField, WriteErrorNavigationRequest, WriteErrorNoMatchField, WriteErrorNonIntegerTTLField, WriteErrorNonListMatchDestField, WriteErrorNonSecureContext, WriteErrorNonStringIdField, WriteErrorNonStringInMatchDestList, WriteErrorNonStringMatchField, WriteErrorNonTokenTypeField, WriteErrorRequestAborted, WriteErrorShuttingDown, WriteErrorTooLongIdField, WriteErrorUnsupportedTypeType: string
Audits.SharedDictionaryIssueDetails #
Type: object
properties
- sharedDictionaryError
- SharedDictionaryError
- request
- AffectedRequest
Audits.SourceCodeLocation #
Type: object
properties
- scriptId
- Runtime.ScriptId
- url
- string
- lineNumber
- integer
- columnNumber
- integer
Audits.SRIMessageSignatureError #
MissingSignatureHeader, MissingSignatureInputHeader, InvalidSignatureHeader, InvalidSignatureInputHeader, SignatureHeaderValueIsNotByteSequence, SignatureHeaderValueIsParameterized, SignatureHeaderValueIsIncorrectLength, SignatureInputHeaderMissingLabel, SignatureInputHeaderValueNotInnerList, SignatureInputHeaderValueMissingComponents, SignatureInputHeaderInvalidComponentType, SignatureInputHeaderInvalidComponentName, SignatureInputHeaderInvalidHeaderComponentParameter, SignatureInputHeaderInvalidDerivedComponentParameter, SignatureInputHeaderKeyIdLength, SignatureInputHeaderInvalidParameter, SignatureInputHeaderMissingRequiredParameters, ValidationFailedSignatureExpired, ValidationFailedInvalidLength, ValidationFailedSignatureMismatch, ValidationFailedIntegrityMismatchType: string
Audits.SRIMessageSignatureIssueDetails #
Type: object
properties
- error
- SRIMessageSignatureError
- signatureBase
- string
- integrityAssertions
- array[ string ]
- request
- AffectedRequest
Audits.StylesheetLoadingIssueDetails #
This issue warns when a referenced stylesheet couldn't be loaded.
Type: object
properties
- sourceCodeLocation
- SourceCodeLocation
Source code position that referenced the failing stylesheet.
- styleSheetLoadingIssueReason
- StyleSheetLoadingIssueReason
Reason why the stylesheet couldn't be loaded.
- failedRequestInfo
- FailedRequestInfo
Contains additional info when the failure was due to a request.
Audits.UnencodedDigestError #
MalformedDictionary, UnknownAlgorithm, IncorrectDigestType, IncorrectDigestLengthType: string
Audits.UnencodedDigestIssueDetails #
Type: object
properties
- error
- UnencodedDigestError
- request
- AffectedRequest
Audits.UserReidentificationIssueDetails #
This issue warns about uses of APIs that may be considered misuse to re-identify users.
Type: object
properties
- type
- UserReidentificationIssueType
- request
- AffectedRequest
Applies to BlockedFrameNavigation and BlockedSubresource issue types.
- sourceCodeLocation
- SourceCodeLocation
Applies to NoisedCanvasReadback issue type.
Audits.UserReidentificationIssueType #
BlockedFrameNavigation, BlockedSubresource, NoisedCanvasReadbackType: string
Audits.NavigatorUserAgentIssueDetails Deprecated #
Type: object
properties
- url
- string
- location
- SourceCodeLocation