Skip to main content
GET
Usage éditeur
GET https://api-datahub.octoparse.com/v1/publisher/usage Authentification : clé API requise (Authorization: Bearer <API Key>). Comment vos apps ont été appelées sur une période : totaux de plage, plus ventilations par jour (ou heure pour les plages courtes), app et canal d’appel (deux dimensions croisées possibles), ou ventilations de diagnostic par état terminal, version ou code d’erreur. C’est le pendant éditeur de l’agrégation de facturation : même vocabulaire (created_from / created_to indexés sur l’heure de début, début inclusif et fin exclusive ; tz_offset ne déplace que les bornes de jour ; data_app / triggered_by restreignent la portée), avec la propriété inversée de « exécutions que j’ai démarrées » vers « apps que je possède » (y compris apps sans release). Les ventilations jour/heure/app/canal viennent de buckets horaires accumulés à l’état terminal, donc toute plage et tout offset d’heure pleine restent exacts et peu coûteux. Les ventilations état/version/erreur se calculent à la demande depuis les détails d’exécution, donc les deux bornes sont requises et l’écart doit être d’au plus 92 jours (400 range-too-wide). Les groupes d’erreur ne couvrent que les exécutions avec erreur ; chaque groupe inclut le message d’erreur le plus récent comme sample_message. Les débogages auteur sont exclus par défaut ; les probes de santé plateforme ne comptent jamais. Le succès inclut le succès partiel ; les annulées restent hors dénominateur du taux de succès ; les métriques sans exécutions terminales sont null. amount est le frais de données payé par les appelants pour ces exécutions, pas le revenu liquidé de l’éditeur. Les groupes jour/heure montent (les clés hour sont l’horloge locale YYYY-MM-DDTHH:00 sous tz_offset, sans suffixe de fuseau). Les autres groupes descendent par nombre d’exécutions. totals.callers est le nombre d’utilisateurs appelants distincts dans la plage, depuis les détails d’exécution, et n’est renseigné que si la plage est bornée et d’au plus 92 jours. group_by=caller ventile une seule app privée ou partagée par appelant : l’auteur (caller_kind=owner) et les utilisateurs actuellement sur la liste de grants (grantee) apparaissent sous leur username actuel ; les autres (ex-grantees, appelants d’une période publique) fusionnent dans un groupe other. Apps publiques ou plusieurs apps → 400 caller-group-unavailable : les appelants d’apps publiques restent anonymes et ne sont que comptés.

Requête

Paramètres de requête

string
défaut:"day"
Une ou deux dimensions, séparées par des virgules : day / hour / data_app / triggered_by / state / version / error / caller (par ex. day,data_app). day et hour ne se combinent pas ; state / version / error / caller exigent une plage bornée d’au plus 92 jours ; caller exige aussi exactement une app privée ou partagée. Défaut day.
string[]
Limiter à ces apps (<username>/<app_name>, répétable). Défaut : toutes vos apps.
string
Début inclusif.
string
Fin exclusive.
integer
défaut:"0"
Offset de fuseau en minutes pour buckets jour/heure. Utilisez 480 pour l’heure standard de Chine. Buckets à grain horaire ; offsets de demi-heure arrondis à l’heure.Plage de -720 à 840.
string
Limiter à un canal d’appel (api / sdk / mcp / web, etc.).
boolean
défaut:"False"
S’il faut inclure les exécutions de débogage auteur.
boolean
défaut:"False"
Renvoie aussi previous_totals pour la fenêtre de même longueur juste avant created_from. Les deux bornes sont requises.

Exemple de requête

Réponse

200 succès

La charge utile est encapsulée dans data. Champs :
object
requis
La plage et l’offset réellement utilisés.
string
Devise.
object
requis
Totaux de la plage.
object
Totaux de la fenêtre précédente de même longueur quand compare=true.
string
Dimension(s) réellement utilisée(s).
object[]
Lignes de groupe. Chaque ligne porte les mêmes métriques que totals, plus les clés de dimension (day / hour / data_app / triggered_by / state / version / error / caller selon group_by).

Erreurs

Les réponses d’erreur utilisent {"error": {code, category, message, retryable}}. Voir Erreurs.

Bibliothèques clientes

Les SDK Python et JavaScript n’encapsulent pas encore cet endpoint. Appelez REST directement.