Mit der Analytics Open API können Sie Daten aus Agorapulse-Berichten auf externe Plattformen exportieren.
Durch die Verwendung der offenen API können Sie Ihre Arbeitsabläufe optimieren und benutzerdefinierte Berichte in Ihren bevorzugten Analyse-, Datenvisualisierungs- oder Business-Intelligence-Tools (BI) außerhalb von Agorapulse erstellen.
In diesem Artikel behandeln wir Folgendes:
Hinweis: Die offene API steht Nutzern mit einem Custom Preisplan zur Verfügung. Wenn Sie Ihren Plan ändern möchten, um auf diese Funktion zugreifen zu können, kontaktieren Sie uns bitte hier.
So generieren Sie einen API-Schlüssel
Bevor Sie mit unserer Open API Berichtsdaten abrufen und weitere Aktionen ausführen können, müssen Sie zunächst einen API-Schlüssel generieren. Gehen Sie dazu wie folgt vor:
Klicken Sie unten links auf dem Bildschirm auf Ihren Avatar.
Wählen Sie Persönliche Einstellungen.
Klicken Sie auf API-Schlüssel.
Klicken Sie oben rechts auf dem Bildschirm auf Neue API-Schlüssel erstellen.
Geben Sie einen Namen für den Schlüssel ein und klicken Sie auf Erstellen.
Klicken Sie auf die Schaltfläche Kopieren.
Hinweis: Der geheime Schlüssel kann nicht erneut angezeigt werden, nachdem Sie diesen Bildschirm verlassen haben.Klicken Sie auf Fertig.
Hinweis: Der API-Schlüssel ist für jede Person individuell, und die für API-Anfragen gewährten Berechtigungen hängen von den Ihnen zugewiesenen Zugriffsrechten ab. Um Daten für alle verbundenen Social-Media-Profile abrufen zu können, empfehlen wir, den API-Schlüssel des Organisationsinhabers oder eines Managers mit Zugriff auf alle Social-Media-Profile zu verwenden.
So authentifizieren Sie Ihre Anfragen
Die API authentifiziert Anfragen mit einem API-Schlüssel, der im HTTP-Header X-API-KEY gesendet wird. Jede Anfrage muss diesen Schlüssel enthalten. Eine Anfrage ohne gültigen Schlüssel gibt 401 Unauthorized zurück.
Um sich in der API-Referenz zu authentifizieren, damit Sie Aufrufe im Browser testen können, gehen Sie bitte wie folgt vor:
Öffnen Sie die API-Referenz.
Suchen Sie in der rechten Spalte das Feld Authentication.
Fügen Sie Ihren API-Schlüssel in das Feld Value ein.
Hinweis: Klicken Sie auf das X rechts neben dem Feld, um den Schlüssel zu löschen.
Ihr Schlüssel bleibt für den Rest Ihrer Sitzung im Feld Value gespeichert, sodass Sie ihn nur einmal eingeben müssen.
Wie man die benötigten IDs erhält
Um Aktionen über die Open API durchführen zu können, benötigen Sie die folgenden drei IDs:
Organisations-ID
Arbeitsbereich-ID
Profil-ID
Hinweis: Um diese IDs abzurufen, müssen Sie unsere API-Dokumentation verwenden https://api.agorapulse.com/docs
So rufen Sie Ihre Organisations-ID ab
Zunächst benötigen Sie die ID Ihrer Organisation. Gehen Sie dazu wie folgt vor:
Öffnen Sie die API-Referenz und vergewissern Sie sich, dass Ihr API-Schlüssel im Feld Authentication eingetragen ist.
Klicken Sie unter Account & Workspaces auf Organizations
Wählen Sie im Dropdown-Menü Get manager organizations aus
Klicken Sie unter Get manager organizations auf Test Request
Klicken Sie oben im Fenster auf Send
Auf der rechten Seite des Fensters wird eine Liste der Organisationen angezeigt, denen Sie angehören, einschließlich der organizationId. Kopieren Sie die Organisations-ID, um Ihre Workspace-ID abzurufen.
So rufen Sie Ihre Workspace-ID ab
Nachdem Sie die Organisations-ID der gewünschten Organisation kopiert haben, müssen Sie die Workspace-ID abrufen. Gehen Sie dazu wie folgt vor:
Klicken Sie unter Account & Workspaces auf Workspaces
Wählen Sie anschließend Get organization workspaces aus
Klicken Sie auf Test Request
Geben Sie unter Variables Ihre Organisations-ID in das Feld organizationID ein
Klicken Sie auf Send
Auf der rechten Seite des Fensters wird eine Liste der verfügbaren Workspaces in Ihrer Organisation angezeigt. Kopieren Sie die Workspace-ID des Workspaces, den Sie verwenden möchten.
Hinweis: Sofern Workspaces/ Arbeitsbereiche in Ihrer Organisation nicht aktiviert sind, wird nur eine Workspace-ID angezeigt.
So rufen Sie Ihre Profil-ID ab
Die letzte ID, die Sie abrufen müssen, ist die ID des Social-Media-Profils, dessen Daten Sie anfragen möchten. Gehen Sie dazu wie folgt vor:
Klicken Sie unter Account & Workspaces auf Profiles
Wählen Sie anschließend Get workspace profiles aus
Klicken Sie auf Test Request
Geben Sie unter Variables Ihre Organisations-ID und Workspace-ID in die entsprechenden Felder ein
Klicken Sie auf Send
Auf der rechten Seite des Fensters wird eine Liste der Social-Media-Profile angezeigt, auf die Sie in Ihrer Organisation Zugriff haben. Kopieren Sie die Profil-UIDs der Social-Media-Profile, die Sie verwenden möchten.
Wichtige Informationen
Es gilt ein Limit von 500 Anfragen pro 30 Minuten.
Es handelt sich um einen reinen Lesezugriff – Sie können über die API nichts ändern oder Aktionen ausführen.
Benutzerdefinierte Berichte und Social-Media-ROI-Berichte sind nicht Teil der API.
Die API beinhaltet keine Listeningdaten.