Visitors

Build Tracked Link

Mint a tracked short link for a destination URL.

Gated on signals:run, NOT signals:read - this mints a durable public URL that attributes real traffic, which is why the app puts it behind the run grant rather than the read one.

post/visitors/links/build

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/visitors/links/build
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

destination_urlstring required

Absolute http(s) URL the link points at.

link_namestring required

Display name. REQUIRED, and not cosmetic: clicks are GROUPED by it, so two links sharing a name report as one.

paramsobject

Static custom params baked into the token.

contact_idinteger nullable

Attribute every click on this link to one contact.

shortenboolean

Mint the LinkedIn-safe short form ({base}/t/{token}) for surfaces that strip fragments and query params.

placementstring

Where the token goes when NOT shortened: fragment (#t=...) or query (?g8t=...). Ignored when shorten is true.

stream_idstring nullable

PUBLIC KEY id of the stream clicks are attributed to - the id shape GET /visitors/streams/list emits, NOT the stream object's own id. Falls back to the org's dedicated tracked-links stream when unset or unresolvable, and is only meaningful with shorten=true.

Response

Successful Response

dataobject required

Changes

No recorded changes to this operation across all 2 revisions of this API.