Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Options to use when deleting a marketing tag.

options

DeleteMarketingTagOptions

Deletes a marketing tag.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  modules: { marketingTags },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function deleteMarketingTag(options) {
  const response = await wixClient.marketingTags.deleteMarketingTag(options);
}

deleteMarketingTag() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  modules: { marketingTags },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function deleteMarketingTag(options) {
  const response = await wixClient.marketingTags.deleteMarketingTag(options);
}

deleteMarketingTag() with Dashboard app access

deleteMarketingTag

void

Information about the marketing tags to retrieve.

ListMarketingTagsOptions

Retrieves marketing tags given the provided filter.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  modules: { marketingTags },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function listMarketingTags(options) {
  const response = await wixClient.marketingTags.listMarketingTags(options);
}

listMarketingTags() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  modules: { marketingTags },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function listMarketingTags(options) {
  const response = await wixClient.marketingTags.listMarketingTags(options);
}

listMarketingTags() with Dashboard app access

listMarketingTags

ListMarketingTagsResponse

MarketingTag

Creates or updates a marketing tag.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  modules: { marketingTags },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function upsertMarketingTag(tag) {
  const response = await wixClient.marketingTags.upsertMarketingTag(tag);
}

upsertMarketingTag() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  modules: { marketingTags },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function upsertMarketingTag(tag) {
  const response = await wixClient.marketingTags.upsertMarketingTag(tag);
}

upsertMarketingTag() with Dashboard app access

upsertMarketingTag

UpsertMarketingTagResponse

To use the MarketingTags API, install the `@wix/marketing-tags` package using npm or Yarn:
  ```console
npm install @wix/marketing-tags
```

or

```console
yarn add @wix/marketing-tags
```

Then import `{ marketingTags }` from `@wix/marketing-tags`:

```js
import { marketingTags } from '@wix/marketing-tags'
```
  

marketing-tags_marketing-tags

Information about the marketing tag to delete.

type

Type

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

string

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

eventTime

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

boolean

FacebookPixel

Domain associated with the Facebook Pixel tag.

domain

Pixel ID in 123456789 format.
Specifies which Facebook Pixel is associated with the site owner.

trackingId

Filter

byType

GoogleAds

Domain associated with the Google Ads Conversion tag.

Conversion ID in AW-123456789 format.
Specifies which Google property is associated with the site owner.

GoogleAnalytics

Domain associated with the Google Analytics tag.

Whether IP addresses of site visitors are hidden from Google.

ipAnonymization

Measurement ID for Google Analytics 4 tags in G-12345 format,
or Analytics ID for Google Universal Analytics tags in UA-12345-1 format.
Specifies which Google property is associated with the site owner.

GoogleAnalyticsConsentMode

GoogleTagManager

Tag Manager Container ID in GTM-12345 format.
Specifies which Google Tag Manager Container is associated with the site owner.

GoogleTagManagerConsentMode

Tag Manager Container ID.
Specifies which Google Tag Manager Container is associated with the site owner.

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

Information about which tags to retrieve.

filter

facebookPixel

A [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091)
lets site owners analyze what a visitor does after clicking on a Google ad.

googleAds

A [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579)
lets site owners track page views, where visitors are coming from, how long they stay, and
what keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310)
and [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310)
are supported.

googleAnalytics

A [Google Analytics consent mode tag](https://developers.google.com/tag-platform/gtagjs/reference)
lets site owners track page views, where visitors are coming from, how long they stay, and
what keywords they used to find the site.

googleAnalyticsConsentMode

A [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530)
lets site owners implement a quick and easy tag management system that keeps
3rd party code snippets organized.

googleTagManager

A [Google tag manager consent mode tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530)
lets site owners implement a quick and easy tag management system that keeps
3rd party code snippets organized.

googleTagManagerConsentMode

A [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663)
allows site owners to share visitor events to TikTok on their site.

tikTokPixel

A [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) lets site
owners build visual reports of visitor activity that helps them evaluate the
performance of their marketing campaigns.

yandexMetrica

Whether this tag is enabled.
Defaults to `true`.

enabled

OnTagCreatedHandler

event

TagCreatedEnvelope

OnTagDeletedHandler

TagDeletedEnvelope

OnTagUpdatedHandler

TagUpdatedEnvelope

entity

metadata

TikTokPixel

Specifies which TikTok Pixel is associated with the site owner.

YandexMetrica

Domain associated with the Yandex Metrica tag.

Yandex Tag Number in 123456789 format.
Specifies which Yandex tag is associated with the site owner.

handler

Triggered when a marketing tag is created.

import { createClient, AppStrategy } from '@wix/sdk';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      marketingTags,
    },
});

wixClient.marketingTags.onTagCreated((event) => {
    // handle your event here
});

onTagCreated()

onTagCreated

Triggered when a marketing tag is deleted.

import { createClient, AppStrategy } from '@wix/sdk';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      marketingTags,
    },
});

wixClient.marketingTags.onTagDeleted((event) => {
    // handle your event here
});

onTagDeleted()

onTagDeleted

Triggered when a marketing tag is updated.

import { createClient, AppStrategy } from '@wix/sdk';
import { marketingTags } from '@wix/marketing-tags';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      marketingTags,
    },
});

wixClient.marketingTags.onTagUpdated((event) => {
    // handle your event here
});

Setup