AdonisJSIn 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-conversion-event.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/get-conversion-event.ts
Terminal
Required parameters
Required parameters
Returns
Returns
A
GetConversionEventResponse. The event. Read its properties (getConversionEvent.event): each says whether the site always sends 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 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.
More examples
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-getConversionEvent.test.ts
conversionEvents.getConversionEvent with factories.GetConversionEventResponse({...}), the fields you give over a valid example (nested ones too).
tests/conversionEvents-getConversionEvent-answer.test.ts
Related
List conversion events (incremental sync)
site.conversionEvents().listConversionEvents()Post a conversion another system saw
site.conversionEvents().createExternalConversionEvent()Retract or restate a conversion event
site.conversionEvents().adjustConversionEvent()GET /conversion-event/{eventId}
The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.