XMLHttpRequest: setAttributionReporting() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
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
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
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 |