Skip to main content

In your app

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

Add the controller

app/Http/Controllers/GetConversionEventController.php

Add the route

routes/web.php

Call it

Terminal
With php artisan serve running, it prints its answer as JSON.
To keep the call in an Action instead, this writes app/Actions/Attract/GetConversionEvent.php (an invokable Action that calls getConversionEvent()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):
Terminal

Call it from the terminal

Terminal
It calls getConversionEvent() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type.

Required parameters

Named arguments, e.g. getConversionEvent(eventId: …); leave out the optional ones.
string
required
Required. The event ID. Matches ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$. At most 128 characters.
A GetConversionEventResponse (Fetchski\AttractCmsLaravel\Data\GetConversionEventResponse). The event. Read its properties ($getConversionEvent->event): each says whether the site always sends it.
ConversionEvent
Always sent. A ConversionEvent. One conversion occurrence. Fields the visitor’s consent did not allow are ABSENT, not empty. Never returned: the visitor’s IP address and user agent, outbox lease and retry bookkeeping.
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).
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
Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.
setup
The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (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 in config/fetchski-attract.php for longer.

More examples

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/GetConversionEventTest.php, then run your tests:
tests/Feature/GetConversionEventTest.php
Terminal
Answer with your own values: fake conversionEvents.getConversionEvent with GetConversionEventResponse::factory()->make([...]), the fields you give over a valid example (nested ones too).
tests/Feature/GetConversionEventAnswerTest.php

List conversion events (incremental sync)

Attract::conversionEvents()->listConversionEvents()

Post a conversion another system saw

Attract::conversionEvents()->createExternalConversionEvent()

Retract or restate a conversion event

Attract::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.