XMLHttpRequest: setAttributionReporting() method
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The setAttributionReporting()
method of the
XMLHttpRequest
interface indicates that you want the request's response to be able to register a JavaScript-based attribution source or attribution trigger.
See the Attribution Reporting API for more details.
Syntax
setAttributionReporting(options)
Parameters
options
-
An object providing attribution reporting options, which includes the following properties:
eventSourceEligible
-
A boolean. If set to
true
, the request's response is eligible to register an attribution source. If set tofalse
, it isn't. triggerEligible
-
A boolean. If set to
true
, the request's response is eligible to register an attribution trigger. If set tofalse
, it isn't.
Return value
None (undefined
).
Exceptions
InvalidStateError
DOMException
-
Thrown if the associated
XMLHttpRequest
has not yet been opened, or has already been sent. TypeError
DOMException
-
Thrown if use of the Attribution Reporting API is blocked by a
attribution-reporting
Permissions-Policy
.
Examples
const attributionReporting = {
eventSourceEligible: true,
triggerEligible: false,
};
function triggerSourceInteraction() {
const req = new XMLHttpRequest();
req.open("GET", "https://shop.example/endpoint");
// Check availability of setAttributionReporting() before calling
if (typeof req.setAttributionReporting === "function") {
req.setAttributionReporting(attributionReporting);
req.send();
} else {
throw new Error("Attribution reporting not available");
// Include recovery code here as appropriate
}
}
// Associate the interaction trigger with whatever
// element and event makes sense for your code
elem.addEventListener("click", triggerSourceInteraction);
Specifications
Specification |
---|
Attribution Reporting # dom-xmlhttprequest-setattributionreporting |
Browser compatibility
BCD tables only load in the browser