---
title: "Generate Tracked Links"
method: POST
path: "/lists/{audience_id}/generate-tracked-links"
tags: ["Lists"]
---

# Generate Tracked Links

`POST /lists/{audience_id}/generate-tracked-links`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/lists/{audience_id}/generate-tracked-links`
- Auth: HTTP bearer

Mint one tracked URL per row, into a column on the list.

`params_template` interpolates this list's own columns - check
`GET /tracked-links/columns` first, because an unresolvable name produces
a link with an empty parameter rather than an error.

`placement` only applies when `shorten` is off.

## Path parameters

- `audience_id` integer, required: List (audience) id.

## Headers

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

## Request body

- GenerateTrackedLinksRequest: Mint one tracked URL per row, into a column on the list.
  - `destination_url` string, required: Absolute http(s) URL every link points at.
  - `link_name` string, required: What this set of links is called.
  - `column_title` string, nullable: Column to write the links into.
  - `params_template` object: Query parameters to interpolate per row, e.g. {'utm_term': '{company}'}.
  - `shorten` boolean: Use the short-link domain.
  - `placement` 'fragment' | 'query': Where the token goes on a NON-shortened URL: `fragment` (#t=…) or `query` (?g8t=…). Ignored when `shorten` is on.
  - `stream_id` string, nullable

## Response `201`

Successful Response

- ApiResponseListPayload
  - `data` ListPayload, required: An open envelope for a list, a capability map or a job result. Open because several of these return the whole `Audience`, whose shape carries per-source metadata that differs between an uploaded file, a dynamic query and a master list - and grows with them.
  - `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)