Individuelle Berichte

Die individuellen Berichte, die im Bereich „Individuelle Berichte“ der App erstellt wurden: Listen Sie diese Berichte auf, rufen Sie einen davon mit den Daten aller Abschnitte (Widgets) so ab, wie die Berichtsseite sie zeigt, und senden Sie ihn sofort an die hinterlegten E-Mail-Adressen. Verfügbar ab Tarif Scale. Die hinterlegten E-Mail-Adressen, das Token des öffentlichen Links und das Passwort werden nie zurückgegeben.

GET/custom_reports

Die individuellen Berichte des Projekts, die neuesten zuerst, jeweils mit dem Zeitraum, dem Zeitplan für den E-Mail-Versand, der Anzahl der hinterlegten E-Mail-Adressen, der Angabe, ob der Bericht über einen öffentlichen Link veröffentlicht ist, und den Abschnitten (Widgets), die er enthält. Auch als MCP-Tool list_custom_reports verfügbar.

Parameter:
  • project_iderforderlich
  • page
  • per_pagestandardmäßig 20, maximal 100
  • output

GET/custom_reports/:id

Die Konfiguration eines Berichts (Zeitraum, Filter für KI-Modell, Tags, Markenbezug und Wettbewerber, Zeitplan, Layout) und die Daten aller Abschnitte (Widgets), zum Zeitpunkt des Abrufs berechnet. Es sind dieselben Zahlen, die auch die Berichtsseite, der öffentliche Link und das PDF zeigen. Jeder Abschnitt hat ein Feld kind und ein Objekt data, dessen Aufbau sich nach diesem Feld richtet: series (timeseries), slices (donut), bars (bar), values und changes (kpi_grid) oder rows (table). Ein Abschnitt, dessen Datenquelle nicht verbunden ist, hat available: false. Der Endpunkt greift nur lesend zu. Auch als MCP-Tool get_custom_report verfügbar.

Parameter:
  • project_iderforderlich
  • :idin der URL

Für einen Bericht außerhalb des Projekts wird ERR_NOT_FOUND zurückgegeben.

POST/custom_reports/:id/send

Sendet den Bericht sofort an die hinterlegten E-Mail-Adressen, wie mit der Schaltfläche „Jetzt senden“ auf der Berichtsseite: Der Bericht muss veröffentlicht sein und mindestens eine hinterlegte E-Mail-Adresse haben (andernfalls ERR_INVALID_PARAM), und jeder Bericht kann höchstens einmal alle 10 Minuten gesendet werden (429 ERR_RATE_LIMITED mit Retry-After). Sobald das PDF in der Warteschlange steht, antwortet die API mit 202. Aus einem White-Label-Portal heraus und für Berichte, die in einem solchen Portal erstellt wurden, ist der Endpunkt nicht verfügbar (ERR_INTEGRATION_UNAVAILABLE). Erfordert einen API-Schlüssel mit Schreibzugriff und bei Teammitgliedern die Berechtigung „Aktualisieren“ für individuelle Berichte. Auch als MCP-Tool send_custom_report verfügbar.

Pfad:
  • :idBerichts-ID

Anfragetext (JSON): project_id (erforderlich).