APIs sind Schnittstellen, über die zwei Systeme automatisch Informationen austauschen können – vergleichbar mit einem Kellner im Restaurant: Du bestellst (Request) und bekommst die gewünschte Information oder Aktion zurück (Response).
Technisch bedeutet das: Dein Browser oder Tool schickt eine Anfrage (Request) an den Server, und der Server liefert die passenden Daten oder führt die gewünschte Aktion aus (Response).
Es gibt dabei verschiedene Arten von Requests (sogenannte HTTP-Methoden), über die dein Browser oder Tool mit einer API kommuniziert.
Hier ein paar der am häufigsten genutzten Beispiele:
GET – Daten abrufen. Beispiel: Du holst dir einen bestimmten Kontakt aus dem CRM.
POST – Neue Daten hinzufügen. Beispiel: Du legst einen neuen Kontakt in einer Kampagne an.
PUT – Bestehende Daten aktualisieren. Beispiel: Du änderst den Status eines Leads (z. B. von neu auf qualifiziert).
Du kannst also über deine API App Kontakte exportieren, hinzufügen oder bestehende Einträge bearbeiten – alles automatisiert.
ℹ️ API App Connection ist ab dem Volume Plan (Legacy) / Scale Plan verfügbar.
Typische Use Cases
Die API eröffnet dir viele Möglichkeiten, deine Prozesse effizienter zu gestalten. Hier ein paar Beispiele:
🚀 Lead-Weiterleitung: Übertrage Leads direkt aus deinem Funnel in dein CRM oder ATS, ohne manuell exportieren zu müssen.
🔄 Datensynchronisierung auf Abruf: Rufe deine Kontakte oder Kampagnendaten genau dann ab, wenn du sie brauchst – zum Beispiel, um aktuelle Leads aus Perspective in dein Reporting-Tool oder CRM zu übernehmen.
📊 Datenanalyse & Reporting: Exportiere Kontakte oder historische Daten, um sie in eigenen Dashboards oder BI-Tools auszuwerten.
🛠️ Individuelle Integrationen: Baue eigene Schnittstellen zu Tools, die aktuell keine Standardintegration mit Perspective haben.
✉️ API gesteuertes Messaging: Änderst du per PUT Request den Status eines Leads (z. B. von neu auf qualifiziert), kannst du damit in deinem externen System direkt Nachrichten-Workflows auslösen. So lassen sich etwa automatisch Follow-up-E-Mails oder WhatsApp-Nachrichten an Leads starten – komplett gesteuert über die API.
So erstellst du deinen API Key
Gehe in deine Account Settings (oben rechts auf das 🛠️ Symbol klicken).
Scrolle runter zu API Key.
Klicke auf Create API Key.
Vergib einen Namen, wähle die passenden Data permissions und den gewünschten Workspace access.
Wichtig❗️: Der API Key wird nur einmal angezeigt. Kopiere ihn jetzt und speichere ihn sicher ab. Danach ist er nicht mehr sichtbar.
API Key Beispiel:
2b5390b22dc5c9b11769aee3a803cf3217a3bc1f595dd396b30a330b902t699c
Füge deinen Perspective API Key nun bei jeder Anfrage im Header ein:
x-perspective-api-key: <dein_api_key>
💡 Hinweis: Nur Perspective Account Admins können API Keys erstellen.
API-Dokumentation & Authentifizierung
Die technische Dokumentation findest du hier: Perspective API Docs. Dort kannst du die API auch direkt testen.
Klicke rechts auf den grünen Button Authorize.
Gib deinen API Key ein.
Klicke auf Authorize – und du bist verbunden.
Verfügbare CRM Endpoints
Im Moment kannst du über die API diese Aktionen im CRM ausführen:
PUT – Einen bestehenden Kontakt aktualisieren (Felder:
firstName,lastName,email,phone,status).GET – Einen einzelnen Lead oder Kontakt über die ID abrufen.
POST – Einen neuen Kontakt in einer Kampagne anlegen (Email oder Phone Pflichtfeld). Aktuell können dabei die folgenden Felder übergeben werden:
firstName,lastName,emailundphone.GET – Eine Liste von Kontakten für eine Kampagne abrufen (inkl. Pagination & Sortierung).
Verfügbare Metrics Endpoints
Neben den CRM-Daten kannst du über die API jetzt auch Performance-Metriken deines Funnels abrufen.
Dafür stehen dir folgende Endpoints zur Verfügung:
GET – KPI Metrics – Ruft die wichtigsten Leistungskennzahlen (KPIs) deines Funnels ab, z. B. Conversion Rates oder abgeschlossene Leads.
GET – Charts Metrics – Liefert Diagramm-Daten zur Funnel-Performance, mit denen du Trends visualisieren und Optimierungspotenziale erkennen kannst.
GET – Insights Metrics – Zeigt detaillierte Einblicke in das Verhalten deiner Besucher, z. B. welche Antworten oder Optionen sie in bestimmten Funnel-Blöcken gewählt haben.
Diese Endpoints helfen dir dabei, Conversion-Raten auszuwerten und das Verhalten deiner Besucher besser zu verstehen.
Um Metriken abzurufen, brauchst du folgende Kennungen:
Funnel ID: Wird für KPI-, Chart- und Insights-Metriken benötigt. Du findest sie in der URL, wenn du deinen Funnel im Editor geöffnet hast.
Insight ID: Wird nur für Insights-Metriken benötigt. Das ist die Tracking ID des Blocks, den du auswerten möchtest.
Um sie zu finden, öffne im Editor deinen Funnel, klicke auf den gewünschten Block und sieh in der linken Seitenleiste im Feld Tracking ID nach.
Filter & Zeiträume
Du kannst Metriken für einen bestimmten Zeitraum abrufen – z. B. nur für die letzten zwei Wochen.
Zeitzonen-Offset
Jede Anfrage kann optional einen Zeitzonen-Offset (in Minuten) enthalten. Dieser legt fest, wie die Zeitstempel der Daten an deine lokale Zeitzone angepasst werden.
Wenn kein Wert gesetzt wird, ist der Standardwert 0.
A/B-Testing
A/B-Test-Daten sind nur für Page-to-Page Conversions verfügbar.
Für den Subtyp chart_page_to_page_conversion_rate kannst du zusätzlich nach einer bestimmten Testvariante filtern, um nur deren Ergebnisse anzuzeigen.