XMLHttpRequest: setAttributionReporting() method - Web APIs | MDN
Syntax
js
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
InvalidStateErrorDOMException-
Thrown if the associated
XMLHttpRequesthas not yet been opened, or has already been sent. TypeErrorDOMException-
Thrown if use of the Attribution Reporting API is blocked by an
attribution-reportingPermissions-Policy.
Examples
js
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 |