Zum Inhalt springen
DOTWICK

API-Referenz

Routen

Routen, die hier nicht aufgeführt sind, gelten nur für die App und werden bei einem Schlüssel mit 403 session_required beantwortet. Als idempotent markierte Routen akzeptieren einen Idempotency-Key.

Codes

MethodePfadScopeZweck
GET/v1/codescodes:readCodes auflisten, nach Ordner, Typ oder Status filtern
POST/v1/codescodes:writeEinen Code erstellenidempotent
GET/v1/codes/{id}codes:readEinen Code mit Design und Regeln abrufen
PATCH/v1/codes/{id}codes:writeZiel, Namen, Design und Regeln ändern
DELETE/v1/codes/{id}codes:writeEinen Code löschen (sein Kurzlink antwortet mit 410)
POST/v1/codes/movecodes:writeCodes in einen Ordner verschiebenidempotent
POST/v1/codes/move-domaincodes:writeCodes auf eine andere Domain verschiebenidempotent
POST/v1/codes/tagscodes:writeTags bei mehreren Codes hinzufügen oder entfernenidempotent
POST/v1/codes/{id}/duplicatecodes:writeEinen Code duplizierenidempotent
PATCH/v1/codes/bulkcodes:writeMehrere Codes pausieren, fortsetzen, archivieren, mit Tags versehen, verschieben oder löschen
GET/v1/utm-presetscodes:readGespeicherte UTM-Vorlagen auflisten
GET/v1/codes/{id}/versionscodes:readZielverlauf eines Codes
GET/v1/codes/{id}/activitycodes:readAktivitätsfeed eines Codes
GET/v1/codes/{id}/exportcodes:readAls SVG, PNG, PDF oder EPS herunterladen
GET/v1/codes/{id}/hosted-statscodes:readZähler eines gehosteten Codes
GET/v1/codes/{id}/submissionssubmissions:readAntworten auf einen Formular-Code
GET/v1/codes/{id}/submissions/exportsubmissions:readFormularantworten als CSV
GET/v1/gs1/productscodes:readGS1-Produkte auflisten (die gs1-Codes)
GET/v1/codes/{id}/gs1/qualifierscodes:readChargen-, CPV- und Seriennummern-Ebenen eines GS1-Codes
GET/v1/codes/{id}/gs1/print-runscodes:readDruckaufträge eines GS1-Codes
GET/v1/codes/{id}/gs1/print-runs/{runId}codes:readDruckauftrag abfragen und die Links zu seinen Dateien abrufen

Massenläufe

MethodePfadScopeZweck
POST/v1/codes/bulkcodes:writeBis zu 500 Codes als einen Lauf erstellenidempotent
GET/v1/bulk-importscodes:readMassenläufe auflisten
GET/v1/bulk-imports/{id}codes:readEinen Massenlauf abfragen
GET/v1/bulk-imports/{id}/rowscodes:readZeilen eines Massenlaufs
GET/v1/bulk-imports/{id}/results.csvcodes:readErgebnisse eines Laufs als CSV
POST/v1/bulk-imports/{id}/cancelcodes:writeEinen wartenden oder laufenden Lauf abbrechenidempotent
POST/v1/bulk-imports/{id}/retrycodes:writeDie fehlgeschlagenen Zeilen eines Laufs wiederholenidempotent

Statistiken

MethodePfadScopeZweck
GET/v1/analytics/summaryanalytics:readScan-Summen für einen Zeitraum
GET/v1/analytics/timeseriesanalytics:readScans im Zeitverlauf
GET/v1/analytics/breakdownanalytics:readTop-Länder, -Geräte,…
GET/v1/analytics/scansanalytics:readDatensätze pro Scan
GET/v1/analytics/sparklinesanalytics:readTageszahlen für Codes
GET/v1/analytics/compareanalytics:readBis zu 4 Codes vergleichen
GET/v1/analytics/exportanalytics:readScans als CSV (kurze Zeiträume)
POST/v1/analytics/exportsanalytics:readScans als CSV, im Hintergrund erstelltidempotent
GET/v1/codes/{id}/analytics/summaryanalytics:readSummen eines Codes
GET/v1/codes/{id}/analytics/timeseriesanalytics:readEin Code im Zeitverlauf
GET/v1/codes/{id}/analytics/breakdownanalytics:readTop-Listen eines Codes
GET/v1/codes/{id}/scansanalytics:readDatensätze pro Scan eines Codes
GET/v1/codes/{id}/gs1/batchesanalytics:readScans pro Charge eines GS1-Codes
GET/v1/codes/{id}/downloadsanalytics:readDownloads pro Datei eines Dokumente-Codes
GET/v1/analytics/locationsanalytics:readGPS-Karte der Scans mit Einwilligung
GET/v1/codes/{id}/analytics/locationsanalytics:readDie GPS-Karte eines Codes
GET/v1/alertsanalytics:readScan-Alarmregeln auflisten

Exporte

MethodePfadScopeZweck
POST/v1/exportscodes:readViele Codes als ein ZIP exportierenidempotent
GET/v1/exportscodes:readExporte auflisten
GET/v1/exports/{id}codes:readEinen Export abfragen und den ZIP-Link erhalten

Ordner

MethodePfadScopeZweck
GET/v1/foldersfolders:readOrdner auflisten
POST/v1/foldersfolders:writeEinen Ordner erstellenidempotent
GET/v1/folders/{id}folders:readEinen Ordner abrufen
PATCH/v1/folders/{id}folders:writeEinen Ordner umbenennen oder verschieben
DELETE/v1/folders/{id}folders:writeEinen Ordner löschen (Codes rücken nach oben)

Vorlagen

MethodePfadScopeZweck
GET/v1/templatestemplates:readDesign-Vorlagen auflisten
POST/v1/templatestemplates:writeEine Vorlage erstellenidempotent
GET/v1/templates/{id}templates:readEine Vorlage abrufen
PATCH/v1/templates/{id}templates:writeEine Vorlage ändern
DELETE/v1/templates/{id}templates:writeEine Vorlage löschen

Uploads

MethodePfadScopeZweck
POST/v1/assetscodes:writeEin Logo oder eine Datei hochladen
GET/v1/assets/{id}codes:readEinen Upload mit signierter URL abrufen

Domains

MethodePfadScopeZweck
GET/v1/domainsdomains:readEigene Domains auflisten
GET/v1/domains/{id}domains:readEine Domain und ihren Status abrufen
GET/v1/subdomaindomains:readDie Subdomain des Arbeitsbereichs und ihre Links
GET/v1/subdomain/availabilitydomains:readPrüfen, ob ein Subdomain-Name frei ist

Arbeitsbereich

MethodePfadScopeZweck
GET/v1/workspaces/currentjeder SchlüsselDer Arbeitsbereich und Tarif des Schlüssels
GET/v1/usagejeder SchlüsselTariflimits und Nutzung in diesem Monat

Webhooks

MethodePfadScopeZweck
GET/v1/webhookswebhooks:readWebhook-Endpunkte auflisten
POST/v1/webhookswebhooks:writeEinen Endpunkt und Ereignistypen registrierenidempotent
GET/v1/webhooks/{id}webhooks:readEinen Endpunkt abrufen
PATCH/v1/webhooks/{id}webhooks:writeEinen Endpunkt ändern oder wieder aktivieren
DELETE/v1/webhooks/{id}webhooks:writeEinen Endpunkt löschen
POST/v1/webhooks/{id}/testwebhooks:writeEin webhook.test-Ereignis sendenidempotent
GET/v1/webhooks/{id}/deliverieswebhooks:readZustellungen eines Endpunkts
GET/v1/webhooks/{id}/deliveries/{deliveryId}webhooks:readEine Zustellung mit ihren Versuchen
POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverwebhooks:writeEine Zustellung erneut sendenidempotent
POST/v1/webhooks/{id}/recoverwebhooks:writeFehlgeschlagene Zustellungen erneut sendenidempotent

Tags

MethodePfadScopeZweck
GET/v1/tagstags:readTags auflisten
POST/v1/tagstags:writeEinen Tag erstellenidempotent
GET/v1/tags/{id}tags:readEinen Tag abrufen
PATCH/v1/tags/{id}tags:writeEinen Tag umbenennen oder umfärben
DELETE/v1/tags/{id}tags:writeEinen Tag löschen (wird von seinen Codes entfernt)

Berichte

MethodePfadScopeZweck
POST/v1/reportsanalytics:readEinen Statistikbericht als PDF oder CSV erstellenidempotent
GET/v1/reportsanalytics:readErstellte Berichte auflisten
GET/v1/reports/{id}analytics:readEinen Bericht abfragen und seinen Link erhalten

Zapier- und Make-Hooks

MethodePfadScopeZweck
GET/v1/hookswebhooks:readIntegrations-Hooks auflisten
POST/v1/hookswebhooks:writeEinen Hook auf ein Ereignis abonnierenidempotent
DELETE/v1/hooks/{id}webhooks:writeEinen Hook abbestellen
GET/v1/hooks/samples/{event}webhooks:readLetzte Ereignisse eines Typs als Beispiel für einen Trigger

Visitenkarten

MethodePfadScopeZweck
GET/v1/cardscards:readTeam-Visitenkarten auflisten
POST/v1/cardscards:writeEine Visitenkarte erstellenidempotent
GET/v1/cards/{id}cards:readEine Visitenkarte abrufen
PATCH/v1/cards/{id}cards:writeEine Visitenkarte ändern
POST/v1/cards/{id}/deactivatecards:writeEine Visitenkarte deaktivierenidempotent
GET/v1/cards/{id}/analyticscards:readAufrufe, Speicherungen und Klicks einer Karte

Conversions

MethodePfadScopeZweck
POST/v1/conversionsconversions:writeEine Conversion erfassenidempotent
GET/v1/analytics/funnelanalytics:readTrichter vom Scan zum Umsatz

NFC-Tags

MethodePfadScopeZweck
GET/v1/nfc/tagscodes:readNFC-Tags auflisten
POST/v1/nfc/tagscodes:writeEinen NFC-Tag für einen Code registrierenidempotent