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:A route handler, a job or a queue worker calls it the same way.
scripts/list-conversion-events.ts
Terminal
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.
Optional parameters
Optional parameters
One object, e.g.
listConversionEvents({ since }); leave out the optional fields.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.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).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.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.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.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.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.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.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.Returns
Returns
A
ConversionEventPage. A page of events. Read its properties (conversionEventPage.events): each says whether the site always sends it.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.Errors
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).
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.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.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.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.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.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: 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.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 status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read:
reason, status.sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.Behavior
- Access: an API key with
conversions:read— or its group masterads:all, oradmin:all— or a signed-in user holding theconversion-events:viewpermission. 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 seeRateLimitedonly 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 whenhasMoreis 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 withnode --test.
tests/conversionEvents-listConversionEvents.test.ts
conversionEvents.listConversionEvents with a sequence() of pages, each factories.ConversionEventPage({...}), and walk listConversionEventsAll().
tests/conversionEvents-listConversionEvents-answer.test.ts
listConversionEventsAll(), answer conversionEvents.listConversionEvents (the walk calls it page by page): a sequence() of answers for several pages.
Related
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.