List the enabled Conversions

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const listConversionDefinitions = await site.conversions().listConversionDefinitions()

{
  "conversions": [
    {
      "id": "ckq1w2e3r4t5y6u7i8o9p0",
      "key": "booking",
      "title": "Booking",
      "currency": "USD",
      "counting": "every",
      "destinations": [
        "google-ads",
        "meta",
        "tiktok"
      ],
      "platforms": {
        "google-ads": {
          "browser": true,
          "server": true
        },
        "meta": {
          "browser": true,
          "server": true
        },
        "tiktok": {
          "browser": false,
          "server": true
        }
      },
      "sendUserData": true,
      "triggers": {
        "forms": 0,
        "pageViews": 0,
        "links": 0,
        "outbound": false,
        "downloads": 0,
        "chat": [],
        "external": true
      }
    }
  ]
}

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const listConversionDefinitions = await site.conversions().listConversionDefinitions()

{
  "conversions": [
    {
      "id": "ckq1w2e3r4t5y6u7i8o9p0",
      "key": "booking",
      "title": "Booking",
      "currency": "USD",
      "counting": "every",
      "destinations": [
        "google-ads",
        "meta",
        "tiktok"
      ],
      "platforms": {
        "google-ads": {
          "browser": true,
          "server": true
        },
        "meta": {
          "browser": true,
          "server": true
        },
        "tiktok": {
          "browser": false,
          "server": true
        }
      },
      "sendUserData": true,
      "triggers": {
        "forms": 0,
        "pageViews": 0,
        "links": 0,
        "outbound": false,
        "downloads": 0,
        "chat": [],
        "external": true
      }
    }
  ]
}

In your app

A controller answers a route on your app: it calls listConversionDefinitions() and returns the answer.

Add the controller

app/controllers/list_conversion_definitions_controller.ts

import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListConversionDefinitionsController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.conversions().listConversionDefinitions()
  }
}

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const ListConversionDefinitionsController = () => import('#controllers/list_conversion_definitions_controller')

router.get('/conversion/definitions', [ListConversionDefinitionsController])

Call it

Terminal

curl http://localhost:3333/conversion/definitions

With node ace serve running, it prints its answer as JSON.

Another system uses it to find the Conversion to post facts to: triggers.external: true accepts POST /conversion-event/external, naming the Conversion by its id or key.

Parameters

None: call it with no arguments.

Returns

A ListConversionDefinitionsResponse. The enabled Conversions. Read its properties (listConversionDefinitions.conversions): each says whether the site always sends it.

readonly ConversionDefinition[]

Always sent. A list of ConversionDefinition.

Show ConversionDefinition

string

Always sent.

string

Always sent. The Conversion’s neutral name (its key in the CMS): what the Data API, webhooks and the events list carry, and what Google Analytics and Tag Manager receive as conversion_key. Matches ^[a-z0-9]+(?:-[a-z0-9]+)*$.

string

Always sent. Matches ^[A-Z]{3}$.

Counting

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

readonly Destinations[]

Always sent. The platforms it sends to (its switched-on rows). Each one of google-ads, ga4, gtm, meta, tiktok.

Readonly<Record<string, ConversionDefinitionPlatformsValue>>

Always sent. A map of names to ConversionDefinitionPlatformsValue. Per platform in destinations: whether the page’s tag sends it, the server, or both.

Show ConversionDefinitionPlatformsValue

boolean

Always sent.

boolean

Always sent.

boolean

Always sent.

ConversionDefinitionTriggers

Always sent. A ConversionDefinitionTriggers.

Show ConversionDefinitionTriggers

Required.

number

Always sent. How many forms fire it. At least 0.

number

Always sent. At least 0.

number

Always sent. How many link rules fire it (phone, email, text, directions, listed websites, written patterns). At least 0.

boolean

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

number

Always sent. How many file types fire it when downloaded. At least 0.

readonly string[]

Always sent.

boolean

Always sent. Accepts facts posted to POST /conversion-event/external.

string

Sometimes sent: undefined when the site leaves it out.

number

Sometimes sent: undefined when the site leaves it out. At least 0.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.

401

The API key is missing, malformed, unknown, disabled, expired or archived (invalid), or a request that must be signed — by the route, or by the key’s own signing mode — has a missing, stale or wrong signature (an upload signs its SHA-256, declared in X-Fetchski-Content-SHA256, in the body’s place) (unauthorized).Retried first: No. Read: siteMessage, errorName, data.

403

The API key lacks the scope this route needs (the message names it), or the key is used from an address outside its allowlist.Retried first: No. Read: siteMessage, errorName, data.

404

Nothing with this identifier — or the caller may not use the Data API at all (anonymous visitors and non-admin sessions get 404 so the API is not advertised). A write while conversion tracking is switched off also answers 404.Retried first: No. Read: siteMessage, errorName, data.

429

The key used up its reads- or writes-per-minute limit (set per key; defaults 600 / 120). Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter (seconds, or null), siteMessage.

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 config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.

setup

The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Access: an API key with conversions:read — or its group master ads:all, or admin:all — or a signed-in user holding the conversion-events:view permission. Anonymous callers get 404.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
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) in config/attract.ts for longer.

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/conversions_list_conversion_definitions.spec.ts, then run your tests:

tests/unit/conversions_list_conversion_definitions.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListConversionDefinitionsController from '#controllers/list_conversion_definitions_controller'

test('conversions.listConversionDefinitions', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListConversionDefinitionsController)
  await controller.handle()

  site.assertCalled('conversions.listConversionDefinitions')
})

Terminal

node ace test

Conversions the page can fire (public)

site.conversions().listActiveConversions()

GET /conversion/definitions

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

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const listConversionDefinitions = await site.conversions().listConversionDefinitions()

{
  "conversions": [
    {
      "id": "ckq1w2e3r4t5y6u7i8o9p0",
      "key": "booking",
      "title": "Booking",
      "currency": "USD",
      "counting": "every",
      "destinations": [
        "google-ads",
        "meta",
        "tiktok"
      ],
      "platforms": {
        "google-ads": {
          "browser": true,
          "server": true
        },
        "meta": {
          "browser": true,
          "server": true
        },
        "tiktok": {
          "browser": false,
          "server": true
        }
      },
      "sendUserData": true,
      "triggers": {
        "forms": 0,
        "pageViews": 0,
        "links": 0,
        "outbound": false,
        "downloads": 0,
        "chat": [],
        "external": true
      }
    }
  ]
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

Test it

Conversions the page can fire (public)

GET /conversion/definitions

In your app

Behavior

Test it

Related

Conversions the page can fire (public)

GET /conversion/definitions