Skip to main content

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-conversion-events.ts

Call it

A script makes the client once and calls the function:
scripts/list-conversion-events.ts
Terminal
A route handler, a job or a queue worker calls it the same way.
Keep the response’s nextCursor and send it as since next time: you receive every new event and every later change to one (a delivery outcome, an adjustment) exactly once more. While hasMore is true, fetch again at once. Filters narrow the page; from / to filter on when the conversion happened (occurredAt), since on when it last changed. Fields the visitor’s consent did not allow are absent. The visitor’s IP address and user agent are never returned.
One object, e.g. listConversionEvents({ since }); leave out the optional fields.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The previous page’s nextCursor, or an ISO 8601 time (changes strictly after it). Omit to start from the beginning.
number | null | undefined
Optional. Leave it out and the site uses 100. Events per page: 1 to 500, 100 when left out (a value outside is refused, 400).
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. A Conversion’s id or key. At most 256 characters.
ListConversionEventsPlatform | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Events that report to this platform. One of google-ads, ga4, gtm, meta, tiktok.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. One visitor’s events. At most 128 characters.
ConversionEventSource | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Where the event was born: the page (browser), this server, or another system (external). One of browser, server, external.
Status | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. active, retracted or adjusted (restated). One of active, retracted, adjusted.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The utm_campaign of the event’s attribution. At most 256 characters.
Date | string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Happened at or after (ISO 8601 date or time). 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. Happened before (ISO 8601 date or time). Format: an ISO 8601 date and time.
A ConversionEventPage. A page of events. Read its properties (conversionEventPage.events): each says whether the site always sends it.
readonly ConversionEvent[]
Always sent. A list of ConversionEvent.
string | null
Always sent, can be null. Pass as since to continue. When the page is empty it echoes the since you sent — keep polling with it.
boolean
Always sent. More changes are waiting right now; fetch again at once.
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 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) on the client for longer.
  • Paging: one page per call. To walk them all, use listConversionEventsAll() (see More examples): it asks for the next page as you iterate, and stops when hasMore is false.

More examples

listConversionEventsAll() takes listConversionEvents()’s arguments except since.

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/conversionEvents-listConversionEvents.test.ts
Answer with your own values: fake conversionEvents.listConversionEvents with a sequence() of pages, each factories.ConversionEventPage({...}), and walk listConversionEventsAll().
tests/conversionEvents-listConversionEvents-answer.test.ts
To fake listConversionEventsAll(), answer conversionEvents.listConversionEvents (the walk calls it page by page): a sequence() of answers for several pages.

Get one conversion event

site.conversionEvents().getConversionEvent()

Post a conversion another system saw

site.conversionEvents().createExternalConversionEvent()

Retract or restate a conversion event

site.conversionEvents().adjustConversionEvent()

GET /conversion-event

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