links

GET /v1/content/link-sets

Your reusable link sets — the URLs you build links to, and the words for each.

Alle links Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/content/link-sets \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

A link set is a named list of destinations and, for each one, every anchor text you want used for it. Recipes point at a set rather than carrying their own copy, so a URL that changes changes in one place. Gated on `links.view`. Each row carries a `distribution`: the resolved share of every (URL, wording) pair, summing to 100. That is computed by the **same** function a recipe run uses, so the preview on screen and the links actually placed cannot disagree. When the shares cannot be resolved, `distribution` is empty and `distribution_error` says why — the two are separate fields because an empty list also means "this set has no links", and one value for two facts is not an answer.

Parameter

NameTypErforderlichWas es ist
org_id (query)stringNein
include_archived (query)booleanNein

Antwort

NameTypErforderlichWas es ist
itemsLinkSet[]Ja
totalintegerJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403