Credits
Das Objekt Credits zeigt, wie viele Credits Ihr Konto hat und was jede Aktion kostet.
GET /contacts/credits gibt dieses Objekt zurück. Ein Beispiel: Bevor Ihr Workflow die E-Mail-Adresse der Vertriebsleitung von Bergquell Mineralbrunnen freischaltet, prüft er hier, ob Ihre Credits reichen.
Die Zahl balance gilt für Ihr ganzes Konto, und das Dashboard zeigt sie im Fenster Credits unter Verfügbare Credits.
Credits in der API beschreibt, welche Aufrufe Credits kosten. Woher Credits stammen und wie Sie weitere kaufen, steht unter Credits.
Abruf
Der Abruf ist kostenlos, ändert Ihre Credits nicht und braucht weder einen bestimmten Plan noch eingerichtete Ansprechpartner.
Sie brauchen den Schlüssel Visitor Intelligence, den Admins unter Menü > Integrationen > API finden. Die Schlüssel für Enrichment und Data Layer funktionieren hier nicht.
curl "https://hub.webmetic.de/contacts/credits" \
-H "Authorization: wmtc_IHR_API_SCHLUESSEL"Felder
Beide Felder sind immer vorhanden und nie null, und costs enthält immer dieselben vier Felder.
| Feld | Typ | Beschreibung |
|---|---|---|
balance | integer | Wie viele Credits Ihr Konto gerade hat |
costs | object | Kosten je Aktion in Credits, für alle Konten gleich |
costs.search | integer | Suche nach Ansprechpartnern. Die Suche ist derzeit kostenlos |
costs.email | integer | Freischalten der E-Mail-Adresse, mit dem LinkedIn-Profil, wenn eines vorliegt |
costs.phone | integer | Freischalten der Rufnummern |
costs.email_phone | integer | Freischalten von E-Mail und Telefon in einem Aufruf. Die Summe aus costs.email und costs.phone |
Regeln
Für die Werte gelten diese Regeln:
- Ganze Zahl:
balanceist immer eine ganze Zahl und nie negativ. - Keine Credits: Wenn Ihr Konto noch nie Credits erhalten oder alle verbraucht hat, ist
balancegleich0, und das ist kein Fehler. Ihr Konto erhält den Willkommensbonus erst, wenn Sie die Ansprechpartner einrichten. - Kein Verfall: Credits verfallen nicht, und Webmetic setzt sie nicht monatlich zurück. Die monatlichen Credits von Starter und Growth kommen zu den vorhandenen hinzu.
- Ein Wert:
balancetrennt nicht nach Herkunft wie Willkommensbonus, Plan oder Kauf. Die API gibt keinen Verlauf der verbrauchten Credits aus. - Listenwerte:
costszeigt, was ein neues Freischalten kostet. Schon freigeschaltete Daten und Datenarten, die Webmetic nicht liefert, kosten nichts. Was ein Aufruf abgebucht hat, steht incredits_usedseiner Antwort, wie unter Contact beschrieben. - Zu wenig Credits: Wenn Ihre Credits nicht reichen, antworten
/contacts/revealund/contacts/findmit Status402und dem CodeINSUFFICIENT_CREDITS.detail.availableim Fehler hat denselben Wert wiebalance, unddetail.requirednennt die Credits für die Aktion. Mehr dazu unter Fehler.
Verwendet von
- Endpunkt:
GET /contacts/credits - Antworten:
credits_remainingin/contacts/search,/contacts/revealund/contacts/find, derselbe Wert wiebalancenach dem Aufruf - KI-Assistent: Auch der KI-Assistent nutzt mit dem Tool
reveal_contactdieselben Credits