Skip to main content

Analytics

Amplitude

Configure Amplitude

Use your Amplitude project API key. The amplitude helper initializes Browser SDK 2 for you, so remove any existing Amplitude snippet or init call.

npm install @c15t/integrations@alpha
src/consent-scripts.ts
import { amplitude } from '@c15t/integrations/amplitude';

export const scripts = [amplitude({ apiKey: 'YOUR_PROJECT_API_KEY' })];

Register the scripts

Complete your framework quickstart first. Keep its Inth endpoint, policy, styles and consent UI. Remove the vendor's original script, SDK initializer or tag-manager entry, so the vendor loads only through c15t.

The vendor pages put the helper in src/consent-scripts.ts. If your framework quickstart already has a scripts array, such as the one in c15t.config.ts in the Next.js guide, add the helper to that array instead of creating a second file. The scripts export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration point for your framework below. These are edits to that provider, not a second provider.

Add the configuration to scripts in c15t.config.ts, next to next.config.ts:

import { defineConsentConfig } from 'c15t/next';
import { scripts } from './src/consent-scripts';

export default defineConsentConfig({ scripts });

Keep the rest of your config, such as mode and routePrefix, in the same call. ConsentRoot reads the config in the browser, so the layout keeps passing only state. App Router, Pages Router and static export all read the same file. See Next.js scripts and embeds.

Options

OptionDefaultBehavior
apiKeyRequiredProject API key passed to amplitude.init. The helper trims it. Empty or whitespace-only values log an error and the script does not load.
initOptions{}Browser SDK 2 options passed as the second argument to init. Use JSON-serializable values only.
scriptUrlhttps://cdn.amplitude.com/libs/analytics-browser-2.44.4-min.js.gzLoader URL override. The default pins Browser SDK 2 version 2.44.4. A blank value falls back to the default.

Loading and revocation

amplitude uses the measurement category. Before measurement is allowed, c15t defines no window.amplitude and loads nothing from Amplitude. When measurement becomes allowed, the helper creates the Browser SDK 2 queue stub, queues init(apiKey, initOptions) and setOptOut(false), then loads the SDK, which replays the queue. Amplitude saves an opt-out in its cookie, so the queued setOptOut(false) clears one left by an earlier revocation.

On revocation the helper calls amplitude.setOptOut(true) and leaves the SDK on the page, because removing the script would not stop the running client. If the visitor allows measurement again before the page reloads, the helper calls setOptOut(false) on that SDK instead of loading a second copy.

Verify Amplitude

After you allow measurement, the analytics-browser-2.44.4-min.js.gz request loads and a test event reaches your Amplitude project. Revoke measurement, then allow it again on a later page and check that events reach Amplitude again.

Test in a private window with an opt-in policy. Open DevTools Network, disable the cache and filter by the vendor's domain:

  1. Load the page. No request goes to the vendor before you choose.
  2. Click Reject, then reload. There is still no vendor request.
  3. Open Privacy settings and allow the helper's category. The vendor script loads without a page reload.
  4. Turn the category off again and save. c15t reloads the page, and the new page makes no vendor request.

c15t reloads on revocation because removing a script element does not stop code that already ran. The vendor's listeners, timers and queued events stay alive until the page unloads. If you set reloadOnConsentRevoked: false, stop the vendor yourself. Register a callback-only script whose onConsentChange calls the vendor's opt-out API, as shown in custom integrations, and check the permission before each of your own event calls. The reload does not delete cookies the vendor already set; see clear on revocation for your framework.

The helper sets vendor to its script ID, so once you declare that vendor a visitor can turn it off inside an allowed category. See vendor consent for your framework. The consent verification guide covers navigation, expiry and hosting checks.