---
title: "Build Tracked Link"
method: POST
path: "/visitors/links/build"
tags: ["Visitors"]
---

# Build Tracked Link

`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

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- TrackedLinkRequest: Mint a tracked short link.
  - `destination_url` string, required: Absolute http(s) URL the link points at.
  - `link_name` string, required: Display name. REQUIRED, and not cosmetic: clicks are GROUPED by it, so two links sharing a name report as one.
  - `params` object: Static custom params baked into the token.
  - `contact_id` integer, nullable: Attribute every click on this link to one contact.
  - `shorten` boolean: Mint the LinkedIn-safe short form (`{base}/t/{token}`) for surfaces that strip fragments and query params.
  - `placement` string: Where the token goes when NOT shortened: `fragment` (`#t=...`) or `query` (`?g8t=...`). Ignored when `shorten` is true.
  - `stream_id` string, 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 `201`

Successful Response

- ApiResponseDict
  - `data` object, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)