Ad-click landings and conversions, aggregated

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

const site = createSiteClient();
const adsMetrics = await site.adsMetrics().getAdsMetrics();

{
  "from": "2026-09-01T00:00:00.000Z",
  "to": "2026-09-22T00:00:00.000Z",
  "groupBy": [
    "day",
    "platform"
  ],
  "landings": {
    "groupBy": [
      "day",
      "platform"
    ],
    "rows": [
      {
        "key": {
          "day": "2026-09-20",
          "platform": "google"
        },
        "landings": 41
      }
    ]
  },
  "conversions": {
    "groupBy": [
      "day",
      "platform"
    ],
    "rows": [
      {
        "key": {
          "currency": "USD",
          "day": "2026-09-20",
          "platform": "google-ads"
        },
        "conversions": 3,
        "retracted": 0,
        "value": 6400,
        "browserSent": 2,
        "serverSent": 3,
        "serverPending": 0,
        "serverFailed": 0,
        "serverSkipped": 0
      }
    ]
  }
}

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

const site = createSiteClient();
const adsMetrics = await site.adsMetrics().getAdsMetrics();

{
  "from": "2026-09-01T00:00:00.000Z",
  "to": "2026-09-22T00:00:00.000Z",
  "groupBy": [
    "day",
    "platform"
  ],
  "landings": {
    "groupBy": [
      "day",
      "platform"
    ],
    "rows": [
      {
        "key": {
          "day": "2026-09-20",
          "platform": "google"
        },
        "landings": 41
      }
    ]
  },
  "conversions": {
    "groupBy": [
      "day",
      "platform"
    ],
    "rows": [
      {
        "key": {
          "currency": "USD",
          "day": "2026-09-20",
          "platform": "google-ads"
        },
        "conversions": 3,
        "retracted": 0,
        "value": 6400,
        "browserSent": 2,
        "serverSent": 3,
        "serverPending": 0,
        "serverFailed": 0,
        "serverSkipped": 0
      }
    ]
  }
}

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/get-ads-metrics.ts

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

export async function getAdsMetrics(site: SiteClient) {
  return site.adsMetrics().getAdsMetrics();
}

Call it

A script makes the client once and calls the function:

scripts/get-ads-metrics.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { getAdsMetrics } from '../src/attract/get-ads-metrics.ts';

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

Terminal

node --env-file=.env scripts/get-ads-metrics.ts

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

Two sections:

landings — page views whose URL carried an ad click ID, from the Request Log (every visitor counts; nothing identifying is used). Empty while the Request Log is switched off. Only day, platform (google, meta, tiktok, other), utmSource, utmCampaign and landingPath apply.
conversions — conversion events by when they happened. Always also grouped by currency. value sums restated values and leaves out retracted events. Grouped by platform (a destination such as google-ads), each row adds browser and server delivery outcomes — the delivery success rate.

Days are UTC. At most 5,000 rows per section.

Optional parameters

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

Date | string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Start (inclusive), ISO 8601 date or time. Default: 30 days before to. Format: an ISO 8601 date and time.

Date | string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. End (exclusive), ISO 8601 date or time. Default: now. Format: an ISO 8601 date and time.

readonly GroupBy[] | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Comma-separated dimensions, or the parameter repeated. Each one of day, conversion, platform, utmSource, utmCampaign, landingPath. No duplicates.

Returns

An AdsMetricsResponse. The aggregates. Read its properties (adsMetrics.from): each says whether the site always sends it.

Date

Always sent. The window’s start (inclusive). Format: an ISO 8601 date and time.

Date

Always sent. The window’s end (exclusive). Format: an ISO 8601 date and time.

readonly GroupBy[]

Always sent. The dimensions asked for. Each one of day, conversion, platform, utmSource, utmCampaign, landingPath.

AdsMetricsResponseLandings

Always sent. An AdsMetricsResponseLandings. Page views whose URL carried an ad click ID (from the Request Log — empty while it is switched off). Grouped only by day, platform (google, meta, …), utmSource, utmCampaign and landingPath.

Show AdsMetricsResponseLandings

readonly string[]

Sometimes sent: undefined when the site leaves it out. The dimensions applied here (the asked-for ones a page view has).

readonly AdsMetricsResponseLandingsRowsItem[]

Sometimes sent: undefined when the site leaves it out. A list of AdsMetricsResponseLandingsRowsItem. One per group, sorted by key (at most 5,000).

Show AdsMetricsResponseLandingsRowsItem

AdsMetricsKey

Always sent. An AdsMetricsKey. The group this row totals; only the requested dimensions (and currency, for conversions) appear.

Show AdsMetricsKey

string

Sometimes sent: undefined when the site leaves it out. Conversions: the currency their value is in (rows never mix currencies); absent for events without one.

Date

Sometimes sent: undefined when the site leaves it out. UTC day. Format: an ISO 8601 date (YYYY-MM-DD).

string

Sometimes sent: undefined when the site leaves it out. Conversions: the Conversion’s id.

string

Sometimes sent: undefined when the site leaves it out. Conversions: a destination (e.g. google-ads, meta); landings: the ad platform of the click id (google, meta, tiktok, other).

string

Sometimes sent: undefined when the site leaves it out. The utm_source of the visit; absent when it had none.

string

Sometimes sent: undefined when the site leaves it out. The utm_campaign of the visit; absent when it had none.

string

Sometimes sent: undefined when the site leaves it out. The page the visit landed on (for a conversion: its last touch, else its first).

number

Always sent. Page views with an ad click id. At least 0.

AdsMetricsResponseConversions

Always sent. An AdsMetricsResponseConversions. Conversion events. value sums restated values and leaves out retracted events. Grouped by platform (a destination such as google-ads), each row adds delivery outcomes.

Show AdsMetricsResponseConversions

readonly string[]

Sometimes sent: undefined when the site leaves it out. The dimensions applied here.

readonly AdsMetricsResponseConversionsRowsItem[]

Sometimes sent: undefined when the site leaves it out. A list of AdsMetricsResponseConversionsRowsItem. One per group (and currency), sorted by key (at most 5,000).

Show AdsMetricsResponseConversionsRowsItem

AdsMetricsKey

Always sent. An AdsMetricsKey. The group this row totals; only the requested dimensions (and currency, for conversions) appear. Its fields are listed under the first AdsMetricsKey above.

number

Always sent. Events not retracted. At least 0.

number

Always sent. Events retracted. At least 0.

number

Always sent. Their value, restated values counted, retracted ones left out.

number

Sometimes sent: undefined when the site leaves it out. Grouped by platform: events the page’s tag sent to it. At least 0.

number

Sometimes sent: undefined when the site leaves it out. Grouped by platform: delivered by the server. At least 0.

number

Sometimes sent: undefined when the site leaves it out. Grouped by platform: owed by the server (queued or retry). At least 0.

number

Sometimes sent: undefined when the site leaves it out. Grouped by platform: server sends that failed. At least 0.

number

Sometimes sent: undefined when the site leaves it out. not-configured, expired, not-sent or no-consent. At least 0.

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).

400

The request is not valid. data.errors lists each problem with the path of the parameter or body field it concerns.Retried first: No. Read: errors (field → messages), siteMessage.

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 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

Access: an API key with ads-metrics:read — or its group master ads:all, or admin:all — or a signed-in user holding the analytics: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) 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/adsMetrics-getAdsMetrics.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { getAdsMetrics } from '../src/attract/get-ads-metrics.ts';

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

GET /ads-metrics

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 adsMetrics = await site.adsMetrics().getAdsMetrics();

{
  "from": "2026-09-01T00:00:00.000Z",
  "to": "2026-09-22T00:00:00.000Z",
  "groupBy": [
    "day",
    "platform"
  ],
  "landings": {
    "groupBy": [
      "day",
      "platform"
    ],
    "rows": [
      {
        "key": {
          "day": "2026-09-20",
          "platform": "google"
        },
        "landings": 41
      }
    ]
  },
  "conversions": {
    "groupBy": [
      "day",
      "platform"
    ],
    "rows": [
      {
        "key": {
          "currency": "USD",
          "day": "2026-09-20",
          "platform": "google-ads"
        },
        "conversions": 3,
        "retracted": 0,
        "value": 6400,
        "browserSent": 2,
        "serverSent": 3,
        "serverPending": 0,
        "serverFailed": 0,
        "serverSkipped": 0
      }
    ]
  }
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Ad-click landings and conversions, aggregated

In your app

Behavior

Test it

GET /ads-metrics

In your app

Behavior

Test it

Related

GET /ads-metrics