@esri/telemetry-siteimprove

Siteimprove plugin for @esri/telemetry. This package creates the Siteimprove script with appropriate attributes and injects it into the DOM.

Table of Contents

• @esri/telemetry-siteimprove
  • Table of Contents
  • Installation
  • Usage
  • How It Works
  • Issues
  • Contributing
  • License

Installation

npm install @esri/telemetry @esri/telemetry-siteimprove

How It Works

@esri/telemetry-siteimprove package works in the client-side browser and server-side Node.js. To use, install the package, include it in your project, create an instance of the plugin, and add it to the plugins array with @esri/telemetry

Below is an example of how to use the browser plugin.

Browser

import { Telemetry } from '@esri/telemetry'
import { Siteimprove } from '@esri/telemetry-siteimprove'

const siteimproveTracker = new Siteimprove({
  code: 'XXXXXX' // required, replace with code
})

const telemetryOptions = {
  plugins: [siteimproveTracker],
  portal: {
    subscriptionInfo: {},
    user: {},
  },
}

const telemetry = new Telemetry(telemetryOptions)
await telemetry.init();

telemetry.logPageView({page: 'home'}) // Required
telemetry.logEvent({
  action: 'Download', // Required
  category: 'Dataset', // Required
  label: 'New' // Optional

})

Server

import { Telemetry } from '@esri/telemetry';
import { Siteimprove } from '@esri/telemetry-siteimprove';

const siteimproveTracker = new Siteimprove({
  code: 'XXXXXX' // required, replace with code
});

const telemetryOptions = {
  plugins: [siteimproveTracker],
  portal: {
    subscriptionInfo: {},
    user: {},
  },
};

const telemetry = new Telemetry(telemetryOptions);

const scriptTags = telemetry.getScriptTags();

After initializing Telemetry.js with the telemetry-siteimprove plugin, telemetry data will be sent to the Siteimprove Analytics instance associated with the provided Siteimprove ID.

Issues

If something isn't working, please take a look at previously logged issues first. Have you found a new bug? Create an issue here.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

License

Copyright © 2022 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file.