Rapports : référence de l’API, points de terminaison et exemples

OpenAPI YAML OpenAPI JSON problèmes YAML Vue d’ensemble de l’API

Ce groupe compte 8 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.

Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.

Rapports : cumuls par dossier et par étiquette, fichiers CSV, XLSX et PDF et envois planifiés par courriel

GET/api/reports¶

Lister les types de rapports

Liste les types de rapports que construit GET /api/reports/{kind}, avec les filtres de chacun, et les formats dans lesquels un rapport s'écrit. Exige la capacité des rapports.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listReportKinds

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Les types de rapports.	ReportCatalog (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/reports/{kind}¶

Obtenir un rapport

Génère un rapport à partir des agrégats du projet (cumuls de disponibilité, lignes d’alertes, état des écrans, diffusion des campagnes directes), jamais à partir d’événements bruts. fleet_health, uptime, publishing et alerts regroupent par group_by folder (par défaut), screen ou tag sur les jours UTC inclusifs de from à to (par défaut les 30 derniers) : un dossier contient chaque écran qu’il renferme et que renferment ses sous-dossiers, et sa première ligne est le projet entier ; folder_id limite le rapport à un dossier et à ce qu’il contient, et avec direct au dossier et à ses sous-dossiers (ou, regroupé par écran, aux écrans qui s’y trouvent directement). alert_log liste chaque alerte déclenchée pendant la période. proof_of_play totalise les diffusions des campagnes directes du projet par campagne, média et écran, pour une campaign_id ou toutes les campagnes d’un annonceur. format json (par défaut) renvoie le tableau ; csv, xlsx et pdf renvoient le même tableau en pièce jointe. fleet_health en JSON est inclus dans tous les forfaits ; tout autre type, et tout format de fichier, nécessite la fonctionnalité de forfait rapports (402 feature_not_in_plan).

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getReport

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
type	chemin	obligatoire	Le type de rapport (GET /api/reports).
format	requête	optionnel	json (par défaut) renvoie le rapport en JSON. csv, xlsx et pdf renvoient les mêmes lignes en pièce jointe (chaque page d'un rapport paginé, jusqu'à 50000 lignes).
de	requête	optionnel	Premier jour UTC, inclus. Par défaut 29 jours avant to. Au plus 366 jours avec to.
à	requête	optionnel	Dernier jour UTC, inclusivement. Par défaut aujourd’hui (UTC).
group_by	requête	optionnel	Ce qu'est une ligne. Sans objet pour alert_log ou proof_of_play.
folder_id	requête	optionnel	Seulement ce dossier d'écrans et tout ce qu'il contient.
direct	requête	optionnel	Avec folder_id : seulement les écrans directement dans le dossier (group_by screen), ou le dossier et ses sous-dossiers directs (group_by folder).
étiquette	requête	optionnel	Seulement les écrans portant cette étiquette.
campaign_id	requête	optionnel	proof_of_play : une campagne directe.
advertiser	requête	optionnel	proof_of_play : les campagnes de cet annonceur ou commanditaire (nom exact, sans égard à la casse).

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Le rapport sous forme de tableau, ou de fichier pour csv, xlsx et pdf.	Rapport (application/json), chaîne (text/csv), chaîne (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), chaîne (application/pdf); en-têtes : Cache-Control
400	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
402	feature_not_in_plan — Les rapports font partie de Plus : tous les types sauf fleet_health en JSON, ainsi que csv, xlsx et pdf de n’importe quel type, les nécessitent. fleet_health en JSON (le format par défaut) est ouvert à tous les forfaits, tout comme les types de rapport et les exportations des routes de rapports existantes. Le problème nomme la fonctionnalité, le forfait du projet et required_plan.	Problème (application/problem+json)
403	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
404	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

GET/api/report-subscriptions¶

Lister les abonnements aux rapports

Liste les rapports planifiés du projet, du plus ancien au plus récent (au plus 50), chacun avec son prochain envoi et le résultat du dernier. Exige la capacité du projet.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: listReportSubscriptions

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Les abonnements aux rapports du projet.	ReportSubscriptionList (application/json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

POST/api/report-subscriptions¶

Créer un abonnement à un rapport

Planifie l'envoi d'un rapport par courriel, en pièce jointe PDF, XLSX ou CSV, chaque jour, chaque semaine ou chaque mois à une heure dans un fuseau horaire.

Chaque envoi couvre la période qui le précède, en jours UTC : la veille, les sept jours précédents ou le mois dernier. recipients sont des membres du projet, désignés par user_id ou par l'adresse courriel du membre; toute autre personne est refusée, de sorte qu'un abonnement ne sert jamais à écrire à un étranger, et un membre qui part cesse de le recevoir.

Une exécution qui échoue est reprise et s’affiche avec last_status failed et last_error. Au plus 50 par organisation, tous projets confondus (report_subscription_limit_reached).

Authentification: projectBearer OU dashboardSession
Corps de la requête: ReportSubscriptionWrite
ID d’opération: createReportSubscription

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.

Champs du corps de la requête

Champ	Description
nom (obligatoire, chaîne)	minLength: 1 maxLength: 100
type (obligatoire, chaîne)	Valeurs permises : "fleet_health", "uptime", "publishing", "alerts", "alert_log", "proof_of_play"
filters (facultatif, objet)	Les filtres du rapport autres que les jours (GET /api/reports les liste).
schedule (obligatoire, ReportSchedule)
format (obligatoire, chaîne)	Valeurs permises : "pdf", "xlsx", "csv"
recipients (obligatoire, tableau)	user_id ou adresse courriel de membres du projet.
activé (optionnel, booléen)	vrai

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
201	Créé.	ReportSubscription (application/json); en-têtes : ETag
400	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
402	feature_not_in_plan — Les rapports font partie de Plus. Le problème nomme la fonctionnalité, le forfait du projet et required_plan.	Problème (application/problem+json)
409	report_subscription_limit_reached.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Obtenir un abonnement à un rapport

Exige la capacité du projet.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: getReportSubscription

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	Un abonnement à un rapport.	ReportSubscription (application/json); en-têtes : ETag
404	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Mettre à jour un abonnement à un rapport

Modifie n'importe lequel de name, filters, schedule, format, recipients et enabled; le type de rapport ne change jamais. Un horaire modifié ou un abonnement réactivé repart à sa prochaine occurrence. If-Match porte la révision lue (revision_conflict si elle est périmée).

Authentification: projectBearer OU dashboardSession
Corps de la requête: ReportSubscriptionPatch
ID d’opération: updateReportSubscription

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.
If-Match	en-tête	optionnel	La révision de l'abonnement, entre guillemets ou non.

Champs du corps de la requête

Champ	Description
nom (optionnel, chaîne)	minLength: 1 maxLength: 100
filters (facultatif, objet)
schedule (facultatif, ReportSchedule)
format (facultatif, chaîne)	Valeurs permises : "pdf", "xlsx", "csv"
recipients (facultatif, tableau)
activé (optionnel, booléen)

Modèle de requête et réponses

shell · modèle de requête

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'

Réponses

Statut	Sens	Corps et en-têtes
200	Mis à jour.	ReportSubscription (application/json); en-têtes : ETag
400	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
402	feature_not_in_plan — Les rapports font partie de Plus ; un changement qui ne fait que désactiver l’abonnement reste ouvert. Le problème nomme la fonctionnalité, le forfait du projet et required_plan.	Problème (application/problem+json)
404	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
409	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Supprimer un abonnement à un rapport

Supprime l'abonnement; plus rien n'est envoyé.

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: deleteReportSubscription

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
204	Supprimé.	pas de corps
404	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)

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

Envoyer un abonnement à un rapport

Envoie le rapport aux destinataires de l'abonnement maintenant, pour la période qu'un envoi planifié couvrirait maintenant, sans déplacer son horaire. La réponse est l'abonnement avec le résultat de cet envoi (last_status delivered ou failed, last_error).

Authentification: projectBearer OU dashboardSession
Corps de la requête: aucun
ID d’opération: sendReportSubscription

Paramètres

Nom	Envoyer	Requis ?	Description
ScreenRig-Project	en-tête	optionnel	Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
id	chemin	obligatoire
Idempotency-Key	en-tête	optionnel	Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement.

Modèle de requête et réponses

shell · modèle de requête

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

Réponses

Statut	Sens	Corps et en-têtes
200	L'abonnement avec le résultat de cet envoi.	ReportSubscription (application/json)
404	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)
par défaut	Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.	Problème (application/problem+json)