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 Berichtsdaten abrufen und andere Aktionen über unsere offene API durchführen können, müssen Sie zunächst einen API-Schlüssel generieren. Dies ist wie folgt möglich:
Klicken Sie auf das Avatarbild unten links auf dem Bildschirm.
Wählen Sie Persönliche Einstellungen
Klicken Sie auf API-Schlüssel
Klicken Sie oben rechts auf dem Bildschirm auf Neuen API-Schlüssel generieren
Geben Sie einen Namen für den Schlüssel ein und klicken Sie auf Erstellen
Sobald der Schlüssel generiert wurde, klicken Sie auf die Schaltfläche Kopieren
zeigen Ihre geheime API nach der Generierung nicht erneut anNachdem Sie Ihren API-Schlüssel kopiert haben, klicken Sie auf Fertig.
Hinweis : Der API-Schlüssel ist für jede Person eindeutig, und die Berechtigungen für API-Anfragen hängen von Ihren Zugriffsrechten ab. Um Daten für alle verbundenen Social-Media-Profile abrufen zu können, empfiehlt es sich den API-Schlüssel des Organisationsinhabers oder -managers mit Zugriff auf alle Social-Media-Profile zu verwenden.
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. Diese erhalten Sie wie folgt:
Öffnen Sie unsere API-Dokumentation
Unter Authentifizierung fügen Sie bitte Ihren API-Schlüssel ein und klicken Sie auf Festlegen
Klicken Sie anschließend auf der linken Seite auf Managerorganisationen abrufen
Klicken Sie auf die Schaltfläche Ausprobieren
Im Antwortfeld sehen Sie eine Liste aller Organisationen, denen Sie angehören, zusammen mit den Organisations-IDs .
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. Dies ist wie folgt möglich:
Scrollen Sie nach unten zum Abschnitt Arbeitsbereich oder klicken Sie auf der linken Seite auf Organisationsarbeitsbereiche abrufen
Fügen Sie Ihre Organisations-ID ein.
Klicken Sie auf die Schaltfläche Probieren
Im Antwortfeld sehen Sie eine Liste aller Ihrer Arbeitsbereiche in Ihrer Organisation sowie die Arbeitsbereichs-ID .
So rufen Sie Ihre Profil-ID ab
Die letzte ID, die Sie benötigen, ist die ID des Social-Media-Profils, von dem Sie Daten anfordern möchten. Dies kann wie folgt erfolgen:
Scrollen Sie nach unten zum Abschnitt Profil oder klicken Sie auf der linken Seite auf Arbeitsbereichsprofile abrufen
Fügen Sie Ihre Organisations-ID und Arbeitsbereichs-ID in die entsprechenden Felder ein.
Klicken Sie auf die Schaltfläche Probieren
Im Antwortfeld sehen Sie eine Liste aller Social-Media-Profile, die dem Arbeitsbereich Ihrer Organisation hinzugefügt wurden, zusammen mit der jeweiligen Profil-ID.
Wie man Analysedaten von der Open API anfordert
Mit Ihrem API-Schlüssel, Ihrer Workspace-, Organisations- und Profil-ID können Sie jetzt Berichtsdaten aus der offenen API für Ihre Zielgruppen , Inhalte (Performance) und Community-Management -Berichte generieren. Analysedaten sind verfügbar für:
Facebook
Instagram
LinkedIn
YouTube
TikTok
Um Analysedaten von der API anzufordern, müssen Sie Folgendes tun:
Im Open API doc unter Bericht auf der linken Seite , wählen Sie den Berichtstyp aus:
Zielgruppe
Community-Management
Inhalte
Unter dem ausgewählten Berichtstyp müssen Sie unter Pfadparameter Folgendes eingeben:
Organisations-ID
Arbeitsbereich-ID
Profil-ID
Anschließend müssen Sie unter Abfrageparameter die folgenden Felder ausfüllen, um den Berichtszeitraum im Zeitstempelformat festzulegen.*
Seit
Bis
Klicken Sie abschließend auf Testen Ihre Analysedaten abzurufen.
Hinweis: Sie können die Datumsangaben für Ihren Berichtszeitraum mithilfe eines Konvertierungstools wie dem unten stehenden in Zeitstempel umwandeln.
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.