Berichte: API-Referenz mit Endpunkten und Beispielen

OpenAPI YAML OpenAPI JSON Probleme YAML API-Überblick

Diese Gruppe hat 8 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.

Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.

Berichte: Rollups nach Ordner und Tag, CSV-, XLSX- und PDF-Dateien und E-Mail-Zeitpläne

GET/api/reports¶

Berichtsarten auflisten

Listet die Berichtsarten, die GET /api/reports/{kind} erstellt, mit den Filtern jeder Art und den Formaten, in denen ein Bericht geschrieben wird. Erfordert die Berichtsberechtigung.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: listReportKinds

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reports'

Antworten

Status	Bedeutung	Textkörper und Header
200	Die Berichtsarten.	ReportCatalog (application/json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/api/reports/{kind}¶

Bericht abrufen

Erstellt einen Bericht aus den Aggregaten des Projekts (Verfügbarkeits-Rollups, Alarmzeilen, Bildschirmzustand, Auslieferung direkter Kampagnen), nie aus Rohereignissen. fleet_health, uptime, publishing und alerts fassen nach group_by folder (Standard), screen oder tag über die einschließlich UTC-Tage von from bis to zusammen (Standard die letzten 30): Ein Ordner enthält jeden Bildschirm darin und in seinen Unterordnern, und seine erste Zeile ist das ganze Projekt; folder_id beschränkt den Bericht auf einen Ordner und dessen Inhalt, mit direct auf den Ordner und seine Unterordner (oder, nach Bildschirm gruppiert, auf die Bildschirme direkt darin). alert_log listet jeden im Zeitraum begonnenen Alarm. proof_of_play summiert die Wiedergaben der direkten Kampagnen des Projekts je Kampagne, Medium und Bildschirm, für eine campaign_id oder alle Kampagnen eines Werbetreibenden. format json (Standard) liefert die Tabelle; csv, xlsx und pdf liefern dieselbe Tabelle als Dateianhang. fleet_health als JSON ist in jedem Plan enthalten; jede andere Art und jedes Dateiformat benötigt die Plan-Funktion Berichte (402 feature_not_in_plan).

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: getReport

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
kind	Pfad	erforderlich	Die Berichtsart (GET /api/reports).
Format	Abfrage	optional	json (Standard) liefert den Bericht als JSON. csv, xlsx und pdf liefern dieselben Zeilen als Dateianhang (jede Seite eines seitenweisen Berichts, bis zu 50000 Zeilen).
von	Abfrage	optional	Erster UTC-Tag, einschließlich. Standard: 29 Tage vor to. Mit to höchstens 366 Tage.
bis	Abfrage	optional	Letzter UTC-Tag, inklusive. Standardmäßig heute (UTC).
group_by	Abfrage	optional	Was eine Zeile ist. Nicht für alert_log oder proof_of_play.
folder_id	Abfrage	optional	Nur dieser Bildschirmordner und alles darin.
direct	Abfrage	optional	Mit folder_id: nur die Bildschirme direkt im Ordner (group_by screen) oder der Ordner und seine direkten Unterordner (group_by folder).
Tag	Abfrage	optional	Nur Bildschirme mit diesem Tag.
campaign_id	Abfrage	optional	proof_of_play: eine direkte Kampagne.
advertiser	Abfrage	optional	proof_of_play: die Kampagnen dieses Werbetreibenden oder Sponsors (genauer Name, Groß- und Kleinschreibung egal).

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reports/KIND'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Bericht als Tabelle oder, für csv, xlsx und pdf, als Datei.	Bericht (application/json), Zeichenfolge (text/csv), Zeichenfolge (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), Zeichenfolge (application/pdf); Header: Cache-Control
400	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
402	feature_not_in_plan — Berichte sind Teil von Plus: Sie werden für jede Art außer fleet_health als JSON sowie für csv, xlsx und pdf jeder Art benötigt. fleet_health als JSON (das Standardformat) ist in jedem Plan offen, ebenso die Berichtsarten und die Exporte der bestehenden Berichtsrouten. Das Problem nennt die Funktion, den Plan des Projekts und required_plan.	Problem (application/problem+json)
403	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
404	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/api/report-subscriptions¶

Berichtsabonnements auflisten

Listet die geplanten Berichte des Projekts, älteste zuerst (höchstens 50), jeden mit seinem nächsten Lauf und dem Ergebnis des letzten. Erfordert die Projektberechtigung.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: listReportSubscriptions

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions'

Antworten

Status	Bedeutung	Textkörper und Header
200	Die Berichtsabonnements des Projekts.	ReportSubscriptionList (application/json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

POST/api/report-subscriptions¶

Berichtsabonnement erstellen

Plant den E-Mail-Versand eines Berichts als PDF-, XLSX- oder CSV-Anhang, täglich, wöchentlich oder monatlich zu einer Uhrzeit in einer Zeitzone.

Jeder Lauf deckt den Zeitraum davor in UTC-Tagen ab: den Vortag, die sieben Tage davor oder den letzten Monat. recipients sind Mitglieder des Projekts, benannt per user_id oder per E-Mail-Adresse des Mitglieds; alle anderen werden abgelehnt, ein Abonnement ist also nie ein Weg, Außenstehende anzuschreiben, und ein Mitglied, das geht, erhält es nicht mehr.

Ein fehlgeschlagener Lauf wird wiederholt und erscheint mit last_status failed und last_error. Höchstens 50 pro Organisation über alle ihre Projekte (report_subscription_limit_reached).

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: ReportSubscriptionWrite
Operations-ID: createReportSubscription

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
Idempotency-Key	Überschrift	optional	Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfrageinhalt-Felder

Feld	Beschreibung
Name (erforderlich, Zeichenkette)	minLength: 1 maxLength: 100
kind (erforderlich, string)	Erlaubt: "fleet_health", "uptime", "publishing", "alerts", "alert_log", "proof_of_play"
filters (optional, Objekt)	Die Filter des Berichts außer den Tagen (GET /api/reports listet sie).
schedule (erforderlich, ReportSchedule)
format (erforderlich, String)	Erlaubt: "pdf", "xlsx", "csv"
recipients (erforderlich, Array)	user_id oder E-Mail-Adresse von Projektmitgliedern.
aktiviert (optional, Boolean)	true

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/report-subscriptions'

Antworten

Status	Bedeutung	Textkörper und Header
201	Erstellt.	ReportSubscription (application/json); Header: ETag
400	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
402	feature_not_in_plan — Berichte sind Teil von Plus. Das Problem nennt die Funktion, den Plan des Projekts und required_plan.	Problem (application/problem+json)
409	report_subscription_limit_reached.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/api/report-subscriptions/{id}¶

Berichtsabonnement abrufen

Erfordert die Projektberechtigung.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: getReportSubscription

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID'

Antworten

Status	Bedeutung	Textkörper und Header
200	Ein Berichtsabonnement.	ReportSubscription (application/json); Header: ETag
404	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

PATCH/api/report-subscriptions/{id}¶

Berichtsabonnement aktualisieren

Ändert eines von name, filters, schedule, format, recipients und enabled; die Berichtsart ändert sich nie. Ein geänderter Zeitplan oder ein wieder aktiviertes Abonnement startet beim nächsten Termin neu. If-Match trägt die gelesene Revision (revision_conflict, wenn sie veraltet ist).

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: ReportSubscriptionPatch
Operations-ID: updateReportSubscription

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich
Idempotency-Key	Überschrift	optional	Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.
If-Match	Überschrift	optional	Die Revision des Abonnements, in Anführungszeichen oder ohne.

Anfrageinhalt-Felder

Feld	Beschreibung
Name (optional, Zeichenkette)	minLength: 1 maxLength: 100
filters (optional, Objekt)
schedule (optional, ReportSchedule)
format (optional, String)	Erlaubt: "pdf", "xlsx", "csv"
recipients (optional, Array)
aktiviert (optional, Boolean)

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID'

Antworten

Status	Bedeutung	Textkörper und Header
200	Aktualisiert.	ReportSubscription (application/json); Header: ETag
400	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
402	feature_not_in_plan — Berichte sind Teil von Plus; eine Änderung, die nur das Abonnement ausschaltet, bleibt offen. Das Problem nennt die Funktion, den Plan des Projekts und required_plan.	Problem (application/problem+json)
404	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
409	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

LÖSCHEN/api/report-subscriptions/{id}¶

Berichtsabonnement löschen

Löscht das Abonnement; es wird nichts mehr gesendet.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: deleteReportSubscription

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich
Idempotency-Key	Überschrift	optional	Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID'

Antworten

Status	Bedeutung	Textkörper und Header
204	Gelöscht.	kein Körper
404	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

POST/api/report-subscriptions/{id}/send¶

Berichtsabonnement senden

Sendet den Bericht jetzt an die Empfänger des Abonnements, für den Zeitraum, den ein geplanter Lauf jetzt abdecken würde, ohne den Zeitplan zu verschieben. Die Antwort ist das Abonnement mit dem Ergebnis dieses Versands (last_status delivered oder failed, last_error).

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: sendReportSubscription

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich
Idempotency-Key	Überschrift	optional	Für einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID/send'

Antworten

Status	Bedeutung	Textkörper und Header
200	Das Abonnement mit dem Ergebnis dieses Versands.	ReportSubscription (application/json)
404	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)