Lists

Generate Tracked Links

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.

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

Path parameters

audience_idinteger required

List (audience) id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

destination_urlstring required

Absolute http(s) URL every link points at.

link_namestring required

What this set of links is called.

column_titlestring nullable

Column to write the links into.

params_templateobject

Query parameters to interpolate per row, e.g. {'utm_term': '{company}'}.

shortenboolean

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_idstring nullable

Response

Successful Response

dataListPayload 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.

Changes

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