Chrome DevTools

Audits Domain

Audits domain allows investigation of page violations and possible improvements.

Experimental

Methods

Events

Types

Methods

Chrome DevTools

Audits.checkContrast #

Runs the contrast check for the target page. Found issues are reported using Audits.issueAdded event.

Parameters

reportAAA
Optional
boolean

Whether to report WCAG AAA level issues. Default is false.


Chrome DevTools

Audits.checkFormsIssues #

Runs the form issues check for the target page. Found issues are reported using Audits.issueAdded event.

Return object

formIssues

Chrome DevTools

Audits.disable #

Disables issues domain, prevents further issues from being reported to the client.


Chrome DevTools

Audits.enable #

Enables issues domain, sends the issues collected so far to the client by means of the issueAdded event.


Chrome DevTools

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
Optional
number

The quality of the encoding (0-1). (defaults to 1)

sizeOnly
Optional
boolean

Whether to only return the size information (defaults to false).

Return object

body
Optional
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

Chrome DevTools

Audits.issueAdded #

Parameters

Types

Chrome DevTools

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

Chrome DevTools

Audits.AffectedFrame #

Information about the frame affected by an inspector issue.

Type: object

Properties

frameId

Chrome DevTools

Audits.AffectedRequest #

Information about a request that is affected by an inspector issue.

Type: object

Properties

requestId
Network.RequestId

The unique request id.

url
Optional
string

Chrome DevTools

Audits.AttributionReportingIssueDetails #

Details for issues around "Attribution Reporting API" usage. Explainer: https://github.com/WICG/attribution-reporting-api

Type: object

Properties

request
Optional
violatingNodeId
Optional
invalidParameter
Optional
string

Chrome DevTools

Audits.AttributionReportingIssueType #

Type: string

Allowed values: PermissionPolicyDisabled, UntrustworthyReportingOrigin, InsecureContext, InvalidHeader, InvalidRegisterTriggerHeader, SourceAndTriggerHeaders, SourceIgnored, TriggerIgnored, OsSourceIgnored, OsTriggerIgnored, InvalidRegisterOsSourceHeader, InvalidRegisterOsTriggerHeader, WebAndOsHeaders, NoWebOrOsSupport, NavigationRegistrationWithoutTransientUserActivation, InvalidInfoHeader, NoRegisterSourceHeader, NoRegisterTriggerHeader, NoRegisterOsSourceHeader, NoRegisterOsTriggerHeader


Chrome DevTools

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

parentFrame
Optional
blockedFrame
Optional

Chrome DevTools

Audits.BlockedByResponseReason #

Enum indicating the reason a response has been blocked. These reasons are refinements of the net error BLOCKED_BY_RESPONSE.

Type: string

Allowed values: CoepFrameResourceNeedsCoepHeader, CoopSandboxedIFrameCannotNavigateToCoopPage, CorpNotSameOrigin, CorpNotSameOriginAfterDefaultedToSameOriginByCoep, CorpNotSameOriginAfterDefaultedToSameOriginByDip, CorpNotSameOriginAfterDefaultedToSameOriginByCoepAndDip, CorpNotSameSite


Chrome DevTools

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 ]

Chrome DevTools

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
clientHintIssueReason

Chrome DevTools

Audits.ClientHintIssueReason #

Type: string

Allowed values: MetaTagAllowListInvalidOrigin, MetaTagModifiedHTML


Chrome DevTools

Audits.ContentSecurityPolicyIssueDetails #

Type: object

Properties

blockedURL
Optional
string

The url not included in allowed sources.

violatedDirective
string

Specific directive that is violated, causing the CSP issue.

isReportOnly
boolean
contentSecurityPolicyViolationType
frameAncestor
Optional
sourceCodeLocation
Optional
violatingNodeId
Optional

Chrome DevTools

Audits.ContentSecurityPolicyViolationType #

Type: string

Allowed values: kInlineViolation, kEvalViolation, kURLViolation, kTrustedTypesSinkViolation, kTrustedTypesPolicyViolation, kWasmEvalViolation


Chrome DevTools

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

Chrome DevTools

Audits.CookieExclusionReason #

Type: string

Allowed values: ExcludeSameSiteUnspecifiedTreatedAsLax, ExcludeSameSiteNoneInsecure, ExcludeSameSiteLax, ExcludeSameSiteStrict, ExcludeInvalidSameParty, ExcludeSamePartyCrossPartyContext, ExcludeDomainNonASCII, ExcludeThirdPartyCookieBlockedInFirstPartySet, ExcludeThirdPartyPhaseout


Chrome DevTools

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
Optional
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
Optional
string
cookieWarningReasons
cookieExclusionReasons
operation
CookieOperation

Optionally identifies the site-for-cookies and the cookie url, which may be used by the front-end as additional context.

siteForCookies
Optional
string
cookieUrl
Optional
string
request
Optional

Chrome DevTools

Audits.CookieOperation #

Type: string

Allowed values: SetCookie, ReadCookie


Chrome DevTools

Audits.CookieWarningReason #

Type: string

Allowed values: WarnSameSiteUnspecifiedCrossSiteContext, WarnSameSiteNoneInsecure, WarnSameSiteUnspecifiedLaxAllowUnsafe, WarnSameSiteStrictLaxDowngradeStrict, WarnSameSiteStrictCrossDowngradeStrict, WarnSameSiteStrictCrossDowngradeLax, WarnSameSiteLaxCrossDowngradeStrict, WarnSameSiteLaxCrossDowngradeLax, WarnAttributeValueExceedsMaxSize, WarnDomainNonASCII, WarnThirdPartyPhaseout, WarnCrossSiteRedirectDowngradeChangesInclusion


Chrome DevTools

Audits.CorsIssueDetails #

Details for a CORS related issue, e.g. a warning or error related to CORS RFC1918 enforcement.

Type: object

Properties

corsErrorStatus
isWarning
boolean
location
Optional
initiatorOrigin
Optional
string
resourceIPAddressSpace
Optional
clientSecurityState
Optional

Chrome DevTools

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
Optional
sourceCodeLocation
type
string

One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5


Chrome DevTools

Audits.FailedRequestInfo #

Type: object

Properties

url
string

The URL that failed to load.

failureMessage
string

The failure message for the failed request.

requestId
Optional

Chrome DevTools

Audits.FederatedAuthRequestIssueDetails #

Type: object

Properties

federatedAuthRequestIssueReason

Chrome DevTools

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.

Type: string

Allowed values: ShouldEmbargo, TooManyRequests, WellKnownHttpNotFound, WellKnownNoResponse, WellKnownInvalidResponse, WellKnownListEmpty, WellKnownInvalidContentType, ConfigNotInWellKnown, WellKnownTooBig, ConfigHttpNotFound, ConfigNoResponse, ConfigInvalidResponse, ConfigInvalidContentType, ClientMetadataHttpNotFound, ClientMetadataNoResponse, ClientMetadataInvalidResponse, ClientMetadataInvalidContentType, DisabledInSettings, ErrorFetchingSignin, InvalidSigninResponse, AccountsHttpNotFound, AccountsNoResponse, AccountsInvalidResponse, AccountsListEmpty, AccountsInvalidContentType, IdTokenHttpNotFound, IdTokenNoResponse, IdTokenInvalidResponse, IdTokenIdpErrorResponse, IdTokenCrossSiteIdpErrorResponse, IdTokenInvalidRequest, IdTokenInvalidContentType, ErrorIdToken, Canceled, RpPageNotVisible, SilentMediationFailure, ThirdPartyCookiesBlocked, NotSignedInWithIdp, MissingTransientUserActivation, ReplacedByButtonMode, RelyingPartyOriginIsOpaque, TypeNotMatching


Chrome DevTools

Audits.FederatedAuthUserInfoRequestIssueDetails #

Type: object

Properties

federatedAuthUserInfoRequestIssueReason

Chrome DevTools

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.

Type: string

Allowed values: NotSameOrigin, NotIframe, NotPotentiallyTrustworthy, NoApiPermission, NotSignedInWithIdp, NoAccountSharingPermission, InvalidConfigOrWellKnown, InvalidAccountsResponse, NoReturningUserFromFetchedAccounts


Chrome DevTools

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
Optional
violatingNodeId
Optional
violatingNodeAttribute
Optional
string
request
Optional

Chrome DevTools

Audits.GenericIssueErrorType #

Type: string

Allowed values: CrossOriginPortalPostMessageError, FormLabelForNameError, FormDuplicateIdForInputError, FormInputWithNoLabelError, FormAutocompleteAttributeEmptyError, FormEmptyIdAndNameAttributesForInputError, FormAriaLabelledByToNonExistingId, FormInputAssignedAutocompleteValueToIdOrNameAttributeError, FormLabelHasNeitherForNorNestedInput, FormLabelForMatchesNonExistingIdError, FormInputHasWrongButWellIntendedAutocompleteValueError, ResponseWasBlockedByORB


Chrome DevTools

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.


Chrome DevTools

Audits.HeavyAdReason #

Type: string

Allowed values: NetworkTotalLimit, CpuTotalLimit, CpuPeakLimit


Chrome DevTools

Audits.HeavyAdResolutionStatus #

Type: string

Allowed values: HeavyAdBlocked, HeavyAdWarning


Chrome DevTools

Audits.InspectorIssue #

An inspector issue reported from the back-end.

Type: object

Properties

issueId
Optional
IssueId

A unique id for this issue. May be omitted if no other entity (e.g. exception, CDP message, etc.) is referencing this issue.


Chrome DevTools

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.

Type: string

Allowed values: CookieIssue, MixedContentIssue, BlockedByResponseIssue, HeavyAdIssue, ContentSecurityPolicyIssue, SharedArrayBufferIssue, LowTextContrastIssue, CorsIssue, AttributionReportingIssue, QuirksModeIssue, NavigatorUserAgentIssue, GenericIssue, DeprecationIssue, ClientHintIssue, FederatedAuthRequestIssue, BounceTrackingIssue, CookieDeprecationMetadataIssue, StylesheetLoadingIssue, FederatedAuthUserInfoRequestIssue, PropertyRuleIssue, SharedDictionaryIssue


Chrome DevTools

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
Optional
mixedContentIssueDetails
Optional
blockedByResponseIssueDetails
Optional
heavyAdIssueDetails
Optional
contentSecurityPolicyIssueDetails
Optional
sharedArrayBufferIssueDetails
Optional
lowTextContrastIssueDetails
Optional
corsIssueDetails
Optional
attributionReportingIssueDetails
Optional
quirksModeIssueDetails
Optional
navigatorUserAgentIssueDetails
Optional
genericIssueDetails
Optional
deprecationIssueDetails
Optional
clientHintIssueDetails
Optional
federatedAuthRequestIssueDetails
Optional
bounceTrackingIssueDetails
Optional
cookieDeprecationMetadataIssueDetails
Optional
stylesheetLoadingIssueDetails
Optional
propertyRuleIssueDetails
Optional
federatedAuthUserInfoRequestIssueDetails
Optional
sharedDictionaryIssueDetails
Optional

Chrome DevTools

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


Chrome DevTools

Audits.LowTextContrastIssueDetails #

Type: object

Properties

violatingNodeId
violatingNodeSelector
string
contrastRatio
number
thresholdAA
number
thresholdAAA
number
fontSize
string
fontWeight
string

Chrome DevTools

Audits.MixedContentIssueDetails #

Type: object

Properties

resourceType
Optional
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
Optional
AffectedRequest

The mixed content request. Does not always exist (e.g. for unsafe form submission urls).

frame
Optional
AffectedFrame

Optional because not every mixed content issue is necessarily linked to a frame.


Chrome DevTools

Audits.MixedContentResolutionStatus #

Type: string

Allowed values: MixedContentBlocked, MixedContentAutomaticallyUpgraded, MixedContentWarning


Chrome DevTools

Audits.MixedContentResourceType #

Type: string

Allowed values: 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, XSLT


Chrome DevTools

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
Optional
string

The value of the property rule property that failed to parse


Chrome DevTools

Audits.PropertyRuleIssueReason #

Type: string

Allowed values: InvalidSyntax, InvalidInitialValue, InvalidInherits, InvalidName


Chrome DevTools

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
url
string
frameId

Chrome DevTools

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
isWarning
boolean

Chrome DevTools

Audits.SharedArrayBufferIssueType #

Type: string

Allowed values: TransferIssue, CreationIssue


Chrome DevTools

Audits.SharedDictionaryError #

Type: string

Allowed values: UseErrorCrossOriginNoCorsRequest, UseErrorDictionaryLoadFailure, UseErrorMatchingDictionaryNotUsed, UseErrorUnexpectedContentDictionaryHeader, WriteErrorCossOriginNoCorsRequest, WriteErrorDisallowedBySettings, WriteErrorExpiredResponse, WriteErrorFeatureDisabled, WriteErrorInsufficientResources, WriteErrorInvalidMatchField, WriteErrorInvalidStructuredHeader, WriteErrorNavigationRequest, WriteErrorNoMatchField, WriteErrorNonListMatchDestField, WriteErrorNonSecureContext, WriteErrorNonStringIdField, WriteErrorNonStringInMatchDestList, WriteErrorNonStringMatchField, WriteErrorNonTokenTypeField, WriteErrorRequestAborted, WriteErrorShuttingDown, WriteErrorTooLongIdField, WriteErrorUnsupportedType


Chrome DevTools

Audits.SharedDictionaryIssueDetails #

Type: object

Properties

sharedDictionaryError

Chrome DevTools

Audits.SourceCodeLocation #

Type: object

Properties

scriptId
Optional
url
string
lineNumber
integer
columnNumber
integer

Chrome DevTools

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
Optional
FailedRequestInfo

Contains additional info when the failure was due to a request.


Chrome DevTools

Audits.StyleSheetLoadingIssueReason #

Type: string

Allowed values: LateImportRule, RequestFailed


Chrome DevTools

Audits.NavigatorUserAgentIssueDetails Deprecated#

Type: object

Properties

url
string
location
Optional