Zum Hauptinhalt springen

Open API von Agorapulse erklärt

Welche Aktionen mit der Open API möglich sind


Mit der Open API von Agorapulse können Sie Ihre Social-Media-Berichtsdaten in externe Systeme integrieren, neue Kalendernotizen oder Entwürfe erstellen und Informationen zu neuen Inbox-Elementen mit externen Tools synchronisieren. So treffen Sie fundiertere Entscheidungen, verbessern die Transparenz und sparen Zeit, indem Sie den Datenabruf automatisieren.

Weitere Informationen dazu, wie Sie einen API-Schlüssel generieren und die Organisations-ID, Workspace-ID und Profil-UIDs abrufen, finden Sie in diesem Artikel.

In diesem Artikel behandeln wir:

Hinweis: Die Open API steht Nutzern mit einem Custom-Preisplan zur Verfügung. Wenn Sie Ihren Plan ändern möchten, um auf diese Funktion zuzugreifen, kontaktieren Sie uns gerne hier.

So navigieren Sie im API-Referenzdokument

In der linken Navigationsleiste der API-Referenz sind alle Endpunkte in die folgenden Kategorien gruppiert:

  • Account & Workspaces: Organizations, Workspaces, Profiles und Groups

  • Publishing: Drafts, Calendar notes und Pinterest boards

  • Content Library: Media

  • Inbox & Engagement: Conversations, Items und Replies

  • Social Listening: Searches, Metrics und Mentions

  • Analytics & Reporting: Reports und Competitors

Auf der Seite jedes Endpunkts werden seine Pfadparameter, Abfrageparameter, der Request Body sowie Beispielantworten angezeigt. Mit Test Request können Sie einen Live-Aufruf mit dem API-Schlüssel aus dem Feld Value senden und erhalten die tatsächliche Antwort aus Ihrem Konto.

Um mit der Spezifikation in Ihren eigenen Tools zu arbeiten, klicken Sie oben auf der Seite auf Download OpenAPI Document.

Was ist mit der Open API verfügbar?


Mit der Open API können Sie Veröffentlichungen, Unterhaltungen in der Social Inbox, Social Listening und Analytics verwalten. In den folgenden Dropdown-Menüs erfahren Sie, welche Aktionen in den einzelnen Bereichen ausgeführt werden können.

Veröffentlichen

Im Bereich Veröffentlichen der Open API können Sie Kalendernotizen suchen, erstellen, bearbeiten und löschen sowie eine Liste der Boards abrufen, die für ein Pinterest-Profil verfügbar sind.

Kalendernotizen

  • Kalendernotizen durchsuchen Durchsucht und filtert Kalendernotizen im angegebenen Workspace

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

    • (Optional) Abfrageparameter

      • Since: Filtert Notizen nach diesem Datum

      • Until: Filtert Notizen vor diesem Datum
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • profileUids: Filtert nach eindeutigen Profilkennungen

  • Neue Kalendernotiz erstellen: Erstellt eine neue Kalendernotiz mit dem angegebenen Inhalt

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • Request Body (Aktualisierte Daten der Kalendernotiz)

      • Color (Farbe der Kalendernotiz). Die verfügbaren Farben für Kalendernotizen sind:

        • BLUE

        • RED

        • YELLOW

        • GREEN

        • PURPLE

        • PINK

        • ORANGE

        • MINT

        • CYAN

        • GREY

      • endDate (Enddatum der Notiz)

      • startDate (Startdatum der Notiz)
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • title (Titel der Notiz)

      • (Optional) body (Inhalt der Notiz)

      • (Optional) profileUids (Liste der eindeutigen Profilkennungen, die mit der Notiz verknüpft sind)

  • Kalendernotiz aktualisieren: Aktualisiert eine bestehende Kalendernotiz mit neuen Daten

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • uid (Eindeutige Kennung der Kalendernotiz)

      • Body (Aktualisierte Daten der Kalendernotiz)

      • Color (Farbe der Kalendernotiz). Die verfügbaren Farben für Kalendernotizen sind:

        • BLUE

        • RED

        • YELLOW

        • GREEN

        • PURPLE

        • PINK

        • ORANGE

        • MINT

        • CYAN

        • GREY

      • endDate (Enddatum der Notiz)

      • startDate (Startdatum der Notiz)
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • title (Titel der Notiz)

      • (Optional) body (Inhalt der Notiz)

      • (Optional) profileUids (Liste der eindeutigen Profilkennungen, die mit der Notiz verknüpft sind)

  • Kalendernotiz löschen Löscht eine Kalendernotiz (löscht eine Kalendernotiz anhand ihrer UID)

    • Erforderliche Parameter:

      • organizationId (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • profileUid (Eindeutige Kennung der Kalendernotiz).

Pinterest Boards

Pinterest Boards auflisten: Listet die Boards auf, in denen ein Pinterest-Profil veröffentlichen kann

  • Erforderliche Parameter:

    • organizationId (Organisationskennung)

    • workspaceId (Workspace-Kennung)

    • profileUid (Kennung des Pinterest-Profils, wie sie vom Profiles-Endpunkt zurückgegeben wird).

Media Center

Im Bereich Media Center der Open API können Sie einen Upload-Slot für Medien erstellen, um Medien in die Content Library hochzuladen, und den Status eines hochgeladenen Medienelements abrufen.
​

Media

  • Media Upload Slot erstellen: Generiert eine vorsignierte Upload-URL und registriert ein Medienelement, das auf den Upload wartet.

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • Body (Zu erstellendes Medium)

      • fileName (Dateiname mit Endung, z. B. clip.mp4).

  • Media Status anfragen: Gibt den aktuellen Status und – nach der Prüfung – die technischen Metadaten des hochgeladenen Mediums zurück

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • mediaUid (Medienkennung).

Inbox & Engagement

Im Bereich Inbox der Open API können Sie Inbox-Elemente abrufen und darauf antworten.

Konversationen

  • Get conversation messages: Liest Unterhaltungsverläufe aus Ihrer Social Inbox.

  • Erforderliche Parameter:

    • organizationID (Organisationskennung)

    • workspaceId (Workspace-Kennung)

    • profileUid (Profilkennung)

    • conversationId (Kennung der Unterhaltung)

  • (Optional) Abfrageparameter:

    • since: Filtert Notizen nach diesem Datum

    • until: Filtert Notizen vor diesem Datum
      ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

    • offset: Offset für die Paginierung

    • limit: Maximale Anzahl der Nachrichten, die pro Seite zurückgegeben werden. Muss zwischen 1 und 25 liegen

    • order: Sortierreihenfolge der Ergebnisse. ASC für aufsteigend (älteste zuerst), DESC für absteigend (neueste zuerst).

Elemente

  • Find items: Sucht Inbox-Elemente (Kommentare, Nachrichten, Bewertungen)

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

    • (Optional) Abfrageparameter:

      • profilUids: Set eindeutiger Profilkennungen zum Filtern der Elemente; mindestens eine ist erforderlich. Es werden nur Elemente dieser Profile zurückgegeben.

      • toReview: Filtert Elemente, die überprüft werden müssen (noch nicht von einem Manager freigegeben)

      • labels: Filtert Elemente nach Labels. Es werden nur Elemente mit diesen Labels zurückgegeben

      • sentiments: Filtert Elemente nach Stimmung (positiv, negativ, neutral)

      • types: Filtert Elemente nach Typ. Geben Sie die Typen der abzurufenden Elemente an:

        • ADS_COMMNENT

        • ORGANIC_COMMENT

        • MENTION

        • RATING

        • REEL_COMMENT

        • STORY_MENTION_CONVERSATION

        • PROFILE_COMMENT

        • PROFILE_MESSAGE

        • profileComment und profileMessage: Geben zurück, was das Profil selbst geantwortet hat. Alle anderen Werte geben eingehende Elemente zurück

      • parentIds: Filtert Elemente nach übergeordnetem Element anhand der Kennung eines von diesem Endpunkt zurückgegebenen Elements. Gibt die untergeordneten Elemente zurück: die Kommentare eines Beitrags, die Antworten auf einen Kommentar, die Nachrichten einer Unterhaltung

      • since: Filtert Notizen nach diesem Datum

      • until: Filtert Notizen vor diesem Datum
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • offset: Offset für die Paginierung

      • limit: Maximale Anzahl der Nachrichten, die pro Seite zurückgegeben werden. Muss zwischen 1 und 25 liegen

      • order: Sortierreihenfolge der Ergebnisse. ASC für aufsteigend (älteste zuerst), DESC für absteigend (neueste zuerst).

  • Get item: Ruft ein Inbox-Element ab (Kommentare, Nachrichten, Bewertungen)

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • profileUid (Profilkennung)

      • itemID (Kennung des Elements, wie sie vom Items-Endpunkt zurückgegeben wird)

Antworten

  • Reply to an item: Antwortet auf ein Inbox-Element

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • profileUid (Profilkennung)

      • Request Body (Anfrage zum Erstellen einer Antwort auf ein Inbox-Element)

      • itemId (Die Kennung des Inbox-Elements, auf das geantwortet werden soll)

      • message (Der Inhalt der Antwortnachricht)

      • (Optional) excludedUsers: Liste der Nutzer-IDs, die von Erwähnungen ausgeschlossen werden sollen (nur für Twitter)

      • (Optional) privateReply: Bei „true“ wird dem Nutzer eine private Nachricht gesendet, anstatt öffentlich auf ein öffentliches Element (z. B. einen Kommentar) zu antworten. Die Antwort wird als Direkt-/Privatnachricht gesendet. Wird nur von Facebook, Instagram und X (Twitter) unterstützt.

Social Listening

Im Bereich Social Listening der Open API können Sie eine Liste aktiver Suchen anzeigen, Metriken aktiver Suchen abrufen (Engagement, Keywords, Stimmung und Volumen) und Elemente finden, die von der Listening-Suche erfasst wurden.

Suchen

  • List searches: Listet die Listening-Suchen eines Workspaces auf, einschließlich der abgedeckten Netzwerke, ihrer Mitbewerber (bei Wettbewerbssuchen) und ihrer Metriken der letzten sieben Tage

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

Metriken

  • Get the search engagement: Summiert die Reaktionen, Kommentare und Shares, die die von einer Listening-Suche erfassten Elemente im angefragten Zeitraum gesammelt haben – als einfache Gesamtwerte oder nach einer Dimension aufgeschlüsselt. Aufrufe werden nicht gezählt.

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • searchID (Die Kennung der Listening-Suche)

    • (Optional) Abfrageparameter:

      • since: Filtert Notizen nach diesem Datum
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until: Filtert Notizen vor diesem Datum

      • networks: Berücksichtigt nur Elemente aus diesen sozialen Netzwerken:

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments: Berücksichtigt nur Elemente mit diesen Stimmungen:

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword: Berücksichtigt nur Elemente, deren extrahierte Keywords dieses Keyword enthalten. Der Abgleich erfolgt exakt und ohne Beachtung der Groß-/Kleinschreibung mit den Werten, die der Keywords-Endpunkt zurückgibt. Ein unbekanntes Keyword liefert ein leeres Ergebnis

      • competitors: Berücksichtigt nur Elemente, die diesen Mitbewerbern zugeordnet wurden; nur für Wettbewerbssuchen. Die Namen entsprechen denen, die der Searches-Endpunkt zurückgibt; ein unbekannter Name oder eine Suche, die keine Wettbewerbssuche ist, wird abgelehnt. Ein Element, das zwei Mitbewerbern zugeordnet ist, wird für beide gezählt

      • groupBy: Lassen Sie diesen Parameter weg, um den Gesamtwert zu erhalten.

        • DATE: Gibt eine Gruppe pro Zeitraumschritt zurück und übernimmt die Granularität

        • NETWORK: Eine Gruppe pro sozialem Netzwerk

        • COMPETITOR: Eine Gruppe pro Mitbewerber einer Wettbewerbssuche

  • Get the search keywords: Listet die Themen auf, über die im Zusammenhang mit einer Listening-Suche im angefragten Zeitraum gesprochen wird – jeweils mit der Anzahl der Elemente, die sie erwähnen, ihrer Klassifizierung und den gesammelten Interaktionen.

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • searchID (Die Kennung der Listening-Suche)

    • (Optional) Abfrageparameter:

      • since: Filtert Notizen nach diesem Datum
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until: Filtert Notizen vor diesem Datum

      • networks: Berücksichtigt nur Elemente aus diesen sozialen Netzwerken:

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments: Berücksichtigt nur Elemente mit diesen Stimmungen:

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword: Berücksichtigt nur Elemente, deren extrahierte Keywords dieses Keyword enthalten. Der Abgleich erfolgt exakt und ohne Beachtung der Groß-/Kleinschreibung mit den Werten, die der Keywords-Endpunkt zurückgibt. Ein unbekanntes Keyword liefert ein leeres Ergebnis

      • competitors: Berücksichtigt nur Elemente, die diesen Mitbewerbern zugeordnet wurden; nur für Wettbewerbssuchen. Die Namen entsprechen denen, die der Searches-Endpunkt zurückgibt; ein unbekannter Name oder eine Suche, die keine Wettbewerbssuche ist, wird abgelehnt. Ein Element, das zwei Mitbewerbern zugeordnet ist, wird für beide gezählt

      • size: Die Anzahl der zurückzugebenden Keywords. Muss zwischen 1 und 100 liegen

  • Get the search sentiment: Klassifiziert die von einer Listening-Suche erfassten Elemente im angefragten Zeitraum als positiv, neutral oder negativ.

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • searchID (Die Kennung der Listening-Suche)

    • (Optional) Abfrageparameter:

      • since: Filtert Notizen nach diesem Datum
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until: Filtert Notizen vor diesem Datum

      • networks: Berücksichtigt nur Elemente aus diesen sozialen Netzwerken:

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments: Berücksichtigt nur Elemente mit diesen Stimmungen:

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword: Berücksichtigt nur Elemente, deren extrahierte Keywords dieses Keyword enthalten. Der Abgleich erfolgt exakt und ohne Beachtung der Groß-/Kleinschreibung mit den Werten, die der Keywords-Endpunkt zurückgibt. Ein unbekanntes Keyword liefert ein leeres Ergebnis

      • competitors: Berücksichtigt nur Elemente, die diesen Mitbewerbern zugeordnet wurden; nur für Wettbewerbssuchen. Die Namen entsprechen denen, die der Searches-Endpunkt zurückgibt; ein unbekannter Name oder eine Suche, die keine Wettbewerbssuche ist, wird abgelehnt. Ein Element, das zwei Mitbewerbern zugeordnet ist, wird für beide gezählt

      • groupBy: Lassen Sie diesen Parameter weg, um den Gesamtwert zu erhalten.

        • DATE: Gibt eine Gruppe pro Zeitraumschritt zurück und übernimmt die Granularität

        • NETWORK: Eine Gruppe pro sozialem Netzwerk

        • COMPETITOR: Eine Gruppe pro Mitbewerber einer Wettbewerbssuche

  • Get the search volume: Zählt die von einer Listening-Suche erfassten Elemente im angefragten Zeitraum

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • searchID (Die Kennung der Listening-Suche)

    • (Optional) Abfrageparameter:

      • since: Filtert Notizen nach diesem Datum
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until: Filtert Notizen vor diesem Datum

      • networks: Berücksichtigt nur Elemente aus diesen sozialen Netzwerken:

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments: Berücksichtigt nur Elemente mit diesen Stimmungen:

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword: Berücksichtigt nur Elemente, deren extrahierte Keywords dieses Keyword enthalten. Der Abgleich erfolgt exakt und ohne Beachtung der Groß-/Kleinschreibung mit den Werten, die der Keywords-Endpunkt zurückgibt. Ein unbekanntes Keyword liefert ein leeres Ergebnis

      • competitors: Berücksichtigt nur Elemente, die diesen Mitbewerbern zugeordnet wurden; nur für Wettbewerbssuchen. Die Namen entsprechen denen, die der Searches-Endpunkt zurückgibt; ein unbekannter Name oder eine Suche, die keine Wettbewerbssuche ist, wird abgelehnt. Ein Element, das zwei Mitbewerbern zugeordnet ist, wird für beide gezählt

      • groupBy: Lassen Sie diesen Parameter weg, um den Gesamtwert zu erhalten.

        • DATE: Gibt eine Gruppe pro Zeitraumschritt zurück und übernimmt die Granularität

        • NETWORK: Eine Gruppe pro sozialem Netzwerk

        • COMPETITOR: Eine Gruppe pro Mitbewerber einer Wettbewerbssuche

Erwähnungen

  • Find items: Listet die von einer Listening-Suche erfassten Elemente auf, optional gefiltert nach Veröffentlichungsdatum, sozialem Netzwerk und Stimmung.

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceId (Workspace-Kennung)

      • searchID (Die Kennung der Listening-Suche)

    • (Optional) Abfrageparameter:

      • since: Filtert Notizen nach diesem Datum
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until: Filtert Notizen vor diesem Datum

      • networks: Berücksichtigt nur Elemente aus diesen sozialen Netzwerken:

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments: Berücksichtigt nur Elemente mit diesen Stimmungen:

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword: Berücksichtigt nur Elemente, deren extrahierte Keywords dieses Keyword enthalten. Der Abgleich erfolgt exakt und ohne Beachtung der Groß-/Kleinschreibung mit den Werten, die der Keywords-Endpunkt zurückgibt. Ein unbekanntes Keyword liefert ein leeres Ergebnis

      • competitors: Berücksichtigt nur Elemente, die diesen Mitbewerbern zugeordnet wurden; nur für Wettbewerbssuchen. Die Namen entsprechen denen, die der Searches-Endpunkt zurückgibt; ein unbekannter Name oder eine Suche, die keine Wettbewerbssuche ist, wird abgelehnt. Ein Element, das zwei Mitbewerbern zugeordnet ist, wird für beide gezählt

      • offset: Von der vorherigen Antwort zurückgegebener Offset, um die nächste Seite abzurufen

      • limit: Maximale Anzahl der Elemente, die pro Seite zurückgegeben werden. Muss zwischen 1 und 25 liegen.

      • orderBy: Feld, nach dem die Elemente sortiert werden.

        • DATE: Nach Veröffentlichungsdatum

        • ENGAGEMENT: Nach den Interaktionen, die das Element gesammelt hat.

Analytics & Reporting


Im Bereich Report der Open API können Sie Berichtsdaten zu Zielgruppe, Inhalten, Community Management und Mitbewerbern abrufen.

Berichte

Die Analytics Open API wird für die folgenden sozialen Netzwerke unterstützt:

  • Facebook

  • Instagram

  • LinkedIn

  • TikTok

  • YouTube

Hinweis: Aufgrund von Einschränkungen in den Nutzungsbedingungen wird X (Twitter) von der Analytics Open API nicht unterstützt.

Die Analytics Open API bietet Zugriff auf dieselben Daten, die über CSV-Exporte aus Agorapulse-Berichten verfügbar sind, darunter:

  • Get Audience report data:

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceID (Workspace-Kennung)

      • profileUid (Kennung des Social-Media-Profils)

      • since (Startdatum des Berichtszeitraums)
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until (Enddatum des Berichtszeitraums)

  • Get Community Management report: Daten des Community-Management-Berichts

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceID (Workspace-Kennung)

      • profileUid (Kennung des Social-Media-Profils)

      • since (Startdatum des Berichtszeitraums)
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until (Enddatum des Berichtszeitraums)

  • Get Content report: Daten des Content-Berichts

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceID (Workspace-Kennung)

      • profileUid (Kennung des Social-Media-Profils)

      • since (Startdatum des Berichtszeitraums)
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until (Enddatum des Berichtszeitraums)

Konkurrenten

Rufen Sie Zielgruppen-Insights Ihrer Mitbewerber ab. Mitbewerberdaten sind nur für Facebook-Seiten und Instagram-Business-Konten verfügbar. Die folgenden Daten können abgerufen werden:

  • Get competitors: Ruft die für das Social-Media-Profil verfolgten Mitbewerber ab

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceID (Workspace-Kennung)

      • profileUid (Kennung des Social-Media-Profils)

  • Get Competitor report insights: Ruft den aggregierten Mitbewerberbericht für das Profil ab

    • Erforderliche Parameter:

      • organizationID (Organisationskennung)

      • workspaceID (Workspace-Kennung)

      • profileUid (Kennung des Social-Media-Profils)

      • since (Startdatum des Berichtszeitraums)
        ​Hinweis: Datumsangaben müssen im Format JJJJ-MM-TT eingegeben werden (z. B. 2024-03-20)

      • until (Enddatum des Berichtszeitraums)

So interpretieren Sie Fehler


Die API verwendet herkömmliche HTTP-Statuscodes. Eine 2xx-Antwort bedeutet Erfolg, eine 4xx-Antwort weist auf ein Problem mit Ihrer Anfrage hin, z. B. einen fehlenden Parameter, eine unbekannte Ressource oder einen fehlenden API-Schlüssel, und eine 5xx-Antwort weist auf ein Problem auf Seiten von Agorapulse hin.
Fehlerantworten enthalten einen JSON-Body, mit Ausnahme von 405, 406 und 415, die nur einen Status zurückgeben.

Beispiel:

{   "code": 1005,   "subCode": 1104,   "message": "Media not found: pubmedia_abc123" }

  • code: Kennzeichnet die Fehlerkategorie. Ein globaler Code steht für 1 (intern), 2 (nicht autorisiert), 3 (Ratenlimit überschritten), 4 (nicht verarbeitbare Eingabe) und 5 (Validierung fehlgeschlagen). Jeder andere Wert kennzeichnet die Komponente, die den Fehler verursacht hat – in der Regel die Funktion, die Sie angesprochen haben. Eine Anfrage, deren Pfad keinem Endpunkt entspricht, wird direkt vom API-Gateway abgelehnt und gibt den gatewayeigenen Code 1013 zurück.

  • subCode: Ist optional. Falls vorhanden, gibt er die genaue Ursache innerhalb dieser Komponente an. Die Endpunkte, die einen subCode zurückgeben, dokumentieren die jeweiligen Werte.

  • message: Liefert eine für Menschen lesbare Erklärung. Werten Sie diese Nachricht nicht in Ihrem Code aus, da sich der Wortlaut ändern kann.

Hat dies deine Frage beantwortet?