Conversions the page can fire (public)

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const listActiveConversions = await site.conversions().listActiveConversions();

{
  "conversions": [
    {
      "id": "ckq1w2e3r4t5y6u7i8o9p0",
      "key": "phone-call",
      "counting": "once",
      "value": null,
      "currency": "USD",
      "sendUserData": true,
      "destinations": [
        "google-ads",
        "ga4"
      ],
      "platforms": {
        "google-ads": {
          "sendTo": "AW-123456789/AbC-D_efG"
        },
        "ga4": {
          "event": "contact"
        }
      },
      "triggers": {
        "forms": [],
        "links": [
          "tel:*"
        ],
        "outbound": false,
        "downloads": [],
        "chat": [],
        "pageView": false
      }
    }
  ]
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const listActiveConversions = await site.conversions().listActiveConversions();

{
  "conversions": [
    {
      "id": "ckq1w2e3r4t5y6u7i8o9p0",
      "key": "phone-call",
      "counting": "once",
      "value": null,
      "currency": "USD",
      "sendUserData": true,
      "destinations": [
        "google-ads",
        "ga4"
      ],
      "platforms": {
        "google-ads": {
          "sendTo": "AW-123456789/AbC-D_efG"
        },
        "ga4": {
          "event": "contact"
        }
      },
      "triggers": {
        "forms": [],
        "links": [
          "tel:*"
        ],
        "outbound": false,
        "downloads": [],
        "chat": [],
        "pageView": false
      }
    }
  ]
}

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/list-active-conversions.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function listActiveConversions(site: SiteClient) {
  return site.conversions().listActiveConversions();
}

Call it

A script makes the client once and calls the function:

scripts/list-active-conversions.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { listActiveConversions } from '../src/attract/list-active-conversions.ts';

const site = createSiteClient();
console.log(await listActiveConversions(site));

Terminal

node --env-file=.env scripts/list-active-conversions.ts

A route handler, a job or a queue worker calls it the same way.

Each enabled Conversion with a browser trigger, compiled, with only its rows sent from the page and its page-view triggers resolved against path to a yes/no. No names, no server-only IDs, and never the site’s page list. Integrations should use GET /conversion/definitions instead.

Optional parameters

One object, e.g. listActiveConversions({ path }); leave out the optional fields.

string | null | undefined

Optional. Leave it out and the site uses "/". The page path the conversions are for. Default /. At most 2048 characters.

Returns

A ListActiveConversionsResponse. The page’s conversions. Read its properties (listActiveConversions.conversions): each says whether the site always sends it.

readonly ListActiveConversionsResponseConversionsItem[]

Always sent. A list of ListActiveConversionsResponseConversionsItem.

Show ListActiveConversionsResponseConversionsItem

string

Always sent.

string

Always sent. The Conversion’s key, sent to Google Analytics and Tag Manager as conversion_key.

Counting

Always sent. One of once, every; a newer site may send others, so keep a fallback.

number | null

Always sent, can be null.

string

Always sent.

boolean

Always sent.

readonly Destinations[]

Always sent. The platforms the page sends this Conversion to. Each one of google-ads, ga4, gtm, meta, tiktok.

Readonly<Record<string, ListActiveConversionsResponseConversionsItemPlatformsValue>>

Always sent. A map of names to ListActiveConversionsResponseConversionsItemPlatformsValue. Per platform in destinations, what its tag needs: the event name (GA4, GTM, Meta, TikTok), or the Google Ads send_to.

Show ListActiveConversionsResponseConversionsItemPlatformsValue

string

Sometimes sent: undefined when the site leaves it out.

string

Sometimes sent: undefined when the site leaves it out.

string

Sometimes sent: undefined when the site leaves it out.

ListActiveConversionsResponseConversionsItemTriggers

Always sent. A ListActiveConversionsResponseConversionsItemTriggers.

Show ListActiveConversionsResponseConversionsItemTriggers

Required.

readonly string[]

Always sent.

readonly string[]

Always sent. Link patterns: a scheme (tel:*, tel:+15550100100), a full address (may end in *), a /path of this site, or a domain.

boolean

Always sent. Fires on any link that leaves the site.

readonly string[]

Always sent. File extensions whose links fire it, e.g. pdf.

readonly Chat[]

Always sent. Each one of chat-started, lead-captured.

boolean

Always sent. Whether viewing path fires it.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage, errorName, data.

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.

setup

sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

setup

The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
Timeout: 15 s per attempt by default; raise timeout (milliseconds) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.

tests/conversions-listActiveConversions.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { listActiveConversions } from '../src/attract/list-active-conversions.ts';

test('conversions.listActiveConversions', async () => {
  const site = fakeSite();
  await listActiveConversions(site);
  site.assertCalled('conversions.listActiveConversions');
});

List the enabled Conversions

site.conversions().listConversionDefinitions()

GET /conversion/active

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const listActiveConversions = await site.conversions().listActiveConversions();

{
  "conversions": [
    {
      "id": "ckq1w2e3r4t5y6u7i8o9p0",
      "key": "phone-call",
      "counting": "once",
      "value": null,
      "currency": "USD",
      "sendUserData": true,
      "destinations": [
        "google-ads",
        "ga4"
      ],
      "platforms": {
        "google-ads": {
          "sendTo": "AW-123456789/AbC-D_efG"
        },
        "ga4": {
          "event": "contact"
        }
      },
      "triggers": {
        "forms": [],
        "links": [
          "tel:*"
        ],
        "outbound": false,
        "downloads": [],
        "chat": [],
        "pageView": false
      }
    }
  ]
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Conversions the page can fire (public)

In your app

Behavior

Test it

List the enabled Conversions

GET /conversion/active

In your app

Behavior

Test it

Related

List the enabled Conversions

GET /conversion/active