trackContentImpression

The trackContentImpression() method tracks the impressions of a content block and passes data about the content name, piece and target.

Syntax

const options = {
  piece: 'contentPiece',
  target: 'contentTarget',
  visitCustomVariables: { index: { name: 'name', value: 'value' },
  customDimensions: { dimensionID: 'value', dimensionID: 'value', },
};
await PiwikProSdk.trackImpression('contentName', options);

Parameters

contentName (string, required)

The name of the tracked content block.

options

Impression tracking options: an object containing four properties.

contentPiece (string, optional)

The piece of the tracked content block. Example: a creative, banner or video.

contentTarget (string, optional)

The target of the tracked content block. Example: a link in the content block.

customDimensions

An object that specifies custom dimensions.

visitCustomVariables

An object that specifies visit custom variables.

Examples

To track the impression of a content block on your mobile app:

const options = {
  piece: 'banner',
  target: 'https://example.com/bikes/',
  visitCustomVariables: { index: { name: 'name', value: 'value' },
  customDimensions: { dimensionID: 'value', dimensionID: 'value', },
};
await PiwikProSdk.trackImpression('gravel bikes collection', options);

Notes

  • To track content impressions, this option needs to be turned on: Menu > Tag Manager > Tags > Piwik PRO (tracking code) > Data collection > Interactions with popups and content (on). Read more
  • Tracked impressions will be visible in Analytics > Reports > Content performance.

Related methods