Zum Inhalt springen
Developer

ShortLink

System und Einstellungen6 EndpunkteServerManagement / ShortLink

Einzelnen ShortLink anlegen

POST/api/servermanagement/shortlink

Request-Body application/json

  • dataShortLink2
    Felder anzeigen (12)
    • short_textstring

      Kurztext des Links, wird in der URL verwendet.

    • long_textstring

      Ziel-URL, auf die der Kurzlink weiterleitet.

    • descriptionstring

      Beschreibung des Kurzlinks.

    • content_typestring

      Art des Inhalts, auf den der Link verweist.

    • utm_idstring

      Für das Tracking verwendete UTM-ID.

    • utm_sourcestring

      Für das Tracking verwendete UTM-Quelle.

    • utm_mediumstring

      Für das Tracking verwendetes UTM-Medium.

    • utm_campaignstring

      Für das Tracking verwendete UTM-Kampagne.

    • utm_termstring

      Für das Tracking verwendeter UTM-Begriff.

    • utm_contentstring

      Für das Tracking verwendeter UTM-Inhalt.

    • tracking_providerstring

      Tracking-Anbieter des Links.

    • archivedboolean

      Ob der Kurzlink archiviert ist.

Antworten

200Einzelnen ShortLink anlegenShortLink3

Felder anzeigen (20)
  • full_urlstring
  • idinteger

    Primärschlüssel des Kurzlinks. Interne ID.

  • short_textstring

    Kurztext des Links, wird in der URL verwendet.

  • long_textstring

    Ziel-URL, auf die der Kurzlink weiterleitet.

  • descriptionstring

    Beschreibung des Kurzlinks.

  • content_typestring

    Art des Inhalts, auf den der Link verweist.

  • utm_idstring

    Für das Tracking verwendete UTM-ID.

  • utm_sourcestring

    Für das Tracking verwendete UTM-Quelle.

  • utm_mediumstring

    Für das Tracking verwendetes UTM-Medium.

  • utm_campaignstring

    Für das Tracking verwendete UTM-Kampagne.

  • utm_termstring

    Für das Tracking verwendeter UTM-Begriff.

  • utm_contentstring

    Für das Tracking verwendeter UTM-Inhalt.

  • tracking_providerstring

    Tracking-Anbieter des Links.

  • archivedboolean

    Ob der Kurzlink archiviert ist.

  • clicks_todayinteger

    Anzahl der Klicks heute.

  • clicks_weekinteger

    Anzahl der Klicks in dieser Woche.

  • clicks_yearinteger

    Anzahl der Klicks in diesem Jahr.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/servermanagement/shortlink \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "short_text": "Text",
    "long_text": "Text",
    "description": "Text",
    "content_type": "string",
    "utm_id": "42",
    "utm_source": "string"
  }
}
'
Antwort 200 application/json
{
  "full_url": "https://vynst.de",
  "id": 42,
  "short_text": "Text",
  "long_text": "Text",
  "description": "Text",
  "content_type": "string",
  "utm_id": "42",
  "utm_source": "string",
  "utm_medium": "string",
  "utm_campaign": "string"
}