Get one visitor’s attribution

use Fetchski\AttractCmsLaravel\Facades\Attract;

$getVisitorAttribution = Attract::visitorAttribution()->getVisitorAttribution(visitorId: '0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c');

{
  "attribution": {
    "visitorId": "0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c",
    "firstTouch": {
      "at": "2026-09-20T09:12:00.000Z",
      "path": "/",
      "landingUrl": "https://example.com/?gclid=Cj0KCQjw&utm_source=google",
      "referrerOrigin": "https://www.google.com",
      "adPlatforms": [
        "google"
      ],
      "campaign": {
        "utm_source": "google",
        "utm_campaign": "spring-sale"
      },
      "clickIds": {
        "gclid": "Cj0KCQjw"
      }
    },
    "browserIds": {
      "_gcl_au": "1.1.1234567890.1790000000"
    },
    "marketing": true,
    "firstSeenAt": "2026-09-20T09:12:00.000Z",
    "lastSeenAt": "2026-09-21T15:04:05.000Z",
    "expiresAt": "2027-03-20T15:04:05.000Z"
  }
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$getVisitorAttribution = Attract::visitorAttribution()->getVisitorAttribution(visitorId: '0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c');

{
  "attribution": {
    "visitorId": "0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c",
    "firstTouch": {
      "at": "2026-09-20T09:12:00.000Z",
      "path": "/",
      "landingUrl": "https://example.com/?gclid=Cj0KCQjw&utm_source=google",
      "referrerOrigin": "https://www.google.com",
      "adPlatforms": [
        "google"
      ],
      "campaign": {
        "utm_source": "google",
        "utm_campaign": "spring-sale"
      },
      "clickIds": {
        "gclid": "Cj0KCQjw"
      }
    },
    "browserIds": {
      "_gcl_au": "1.1.1234567890.1790000000"
    },
    "marketing": true,
    "firstSeenAt": "2026-09-20T09:12:00.000Z",
    "lastSeenAt": "2026-09-21T15:04:05.000Z",
    "expiresAt": "2027-03-20T15:04:05.000Z"
  }
}

In your app

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

Add the controller

app/Http/Controllers/GetVisitorAttributionController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\GetVisitorAttributionResponse;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class GetVisitorAttributionController
{
    public function __invoke(string $visitorId): GetVisitorAttributionResponse
    {
        return Attract::visitorAttribution()->getVisitorAttribution(visitorId: $visitorId);
    }
}

Add the route

routes/web.php

use App\Http\Controllers\GetVisitorAttributionController;
use Illuminate\Support\Facades\Route;

Route::get('/visitor-attribution/{visitorId}', GetVisitorAttributionController::class);

Call it

Terminal

curl http://localhost:8000/visitor-attribution/0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c

With php artisan serve running, it prints its answer as JSON.

To keep the call in an Action instead, this writes app/Actions/Attract/GetVisitorAttribution.php (an invokable Action that calls getVisitorAttribution()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action visitorAttribution.getVisitorAttribution

Call it from the terminal

Terminal

php artisan attract:call visitorAttribution.getVisitorAttribution \
  visitorId=0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c

It calls getVisitorAttribution() 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. getVisitorAttribution(visitorId: …); leave out the optional ones.

string

required

Required. The visitor ID. At most 128 characters.

Returns

A GetVisitorAttributionResponse (Fetchski\AttractCmsLaravel\Data\GetVisitorAttributionResponse). The record. Read its properties ($getVisitorAttribution->attribution): each says whether the site always sends it.

VisitorAttribution

Always sent. A VisitorAttribution. One visitor’s attribution record. Kept for the site’s retention setting after the visitor’s last page view.

Show VisitorAttribution (Fetchski\AttractCmsLaravel\Data\VisitorAttribution)

string

Always sent.

AttributionTouch

Always sent. An AttributionTouch. One touch of a visitor’s journey on this site. Identifier values (clickIds, linker) appear only when the visitor allowed Marketing.

Show AttributionTouch (Fetchski\AttractCmsLaravel\Data\AttributionTouch)

The visitor’s first visit on record; null when unknown.

?CarbonImmutable

Sometimes sent: null when the site leaves it out. When the page view happened. Format: an ISO 8601 date and time.

?string

Sometimes sent: null when the site leaves it out. The page’s path.

?string

Sometimes sent: null when the site leaves it out. The full landing URL. Without Marketing consent its identifier parameters are removed. Format: an absolute URL.

?string

Sometimes sent: null when the site leaves it out. Where the visitor came from; null for a direct visit.

Collection<int, Enums\AdPlatforms|string>|null

Sometimes sent: null when the site leaves it out. Platforms whose ad click ID the URL carried — kept for every visitor, consent or not. Each one of google, meta, tiktok, other.

array<string, string>|null

Sometimes sent: null when the site leaves it out. UTM and campaign parameters (utm_*, gad_source, gad_campaignid, srsltid).

array<string, string>|null

Sometimes sent: null when the site leaves it out. Ad click IDs (gclid, gbraid, wbraid, fbclid, ttclid). Marketing only.

array<string, string>|null

Sometimes sent: null when the site leaves it out. Google’s cross-domain linker value (_gl). Marketing only.

bool

Always sent. Whether the visitor allowed Marketing on their latest page view.

CarbonImmutable

Always sent. Format: an ISO 8601 date and time.

CarbonImmutable

Always sent. Format: an ISO 8601 date and time.

CarbonImmutable

Always sent. Format: an ISO 8601 date and time.

?AttributionTouch

Sometimes sent: null when the site leaves it out. An AttributionTouch. One touch of a visitor’s journey on this site. Identifier values (clickIds, linker) appear only when the visitor allowed Marketing. Its fields are listed under the first AttributionTouch above.

array<string, string>|null

Sometimes sent: null when the site leaves it out. Ad-platform browser IDs (_gcl_au — the cross-site key — _gcl_aw, _gcl_gb, _gcl_gs, _gcl_dc, _ga, _fbp, _fbc, _ttp). Marketing only.

Errors

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 attribution:read — or its group master ads:all, or admin:all — or a signed-in user holding the attribution: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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$getVisitorAttribution = Attract::visitorAttribution()->findVisitorAttribution(visitorId: '0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c'); // ?GetVisitorAttributionResponse: null when the site answers 404

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/GetVisitorAttributionTest.php, then run your tests:

tests/Feature/GetVisitorAttributionTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetVisitorAttributionTest extends TestCase
{
    public function test_get_visitor_attribution(): void
    {
        Attract::fake();

        $this->getJson('/visitor-attribution/0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c')->assertOk();

        Attract::assertCalled('visitorAttribution.getVisitorAttribution', fn (array $args): bool => $args['visitorId'] === '0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c');
    }
}

Terminal

php artisan test

Answer with your own values: fake visitorAttribution.getVisitorAttribution with GetVisitorAttributionResponse::factory()->make([...]), the fields you give over a valid example (nested ones too).

tests/Feature/GetVisitorAttributionAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\GetVisitorAttributionResponse;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetVisitorAttributionAnswerTest extends TestCase
{
    public function test_get_visitor_attribution_answers_your_values(): void
    {
        Attract::fake([
            'visitorAttribution.getVisitorAttribution' => GetVisitorAttributionResponse::factory()->make(['attribution' => ['visitorId' => 'Your value']]),
        ]);

        $getVisitorAttribution = Attract::visitorAttribution()->getVisitorAttribution(visitorId: '0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c');

        $this->assertSame('Your value', $getVisitorAttribution->attribution->visitorId);
    }
}

Find visitors by an identifier

Attract::visitorAttribution()->findVisitorAttributions()

GET /visitor-attribution/{visitorId}

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$getVisitorAttribution = Attract::visitorAttribution()->getVisitorAttribution(visitorId: '0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c');

{
  "attribution": {
    "visitorId": "0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c",
    "firstTouch": {
      "at": "2026-09-20T09:12:00.000Z",
      "path": "/",
      "landingUrl": "https://example.com/?gclid=Cj0KCQjw&utm_source=google",
      "referrerOrigin": "https://www.google.com",
      "adPlatforms": [
        "google"
      ],
      "campaign": {
        "utm_source": "google",
        "utm_campaign": "spring-sale"
      },
      "clickIds": {
        "gclid": "Cj0KCQjw"
      }
    },
    "browserIds": {
      "_gcl_au": "1.1.1234567890.1790000000"
    },
    "marketing": true,
    "firstSeenAt": "2026-09-20T09:12:00.000Z",
    "lastSeenAt": "2026-09-21T15:04:05.000Z",
    "expiresAt": "2027-03-20T15:04:05.000Z"
  }
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Behavior

More examples

Test it

Find visitors by an identifier

GET /visitor-attribution/{visitorId}

In your app

Call it from the terminal

Behavior

More examples

Test it

Related

Find visitors by an identifier

GET /visitor-attribution/{visitorId}