Publishing
Usage publisher
Come sono state chiamate le tue app pubblicate in un periodo: totali più suddivisioni per giorno, ora, app, canale, stato, versione, codice errore o caller.
GET
Usage publisher
GET https://api-datahub.octoparse.com/v1/publisher/usage
Autenticazione: API key obbligatoria (Authorization: Bearer <API Key>).
Come sono state chiamate le tue app in un periodo: totali dell’intervallo, più ripartizioni per giorno (o per ora negli intervalli brevi), app e canale di chiamata (due qualsiasi possono essere incrociati), oppure ripartizioni diagnostiche per stato terminale, versione o codice di errore. È la controparte lato publisher dell’aggregazione della fatturazione: stesso vocabolario (created_from / created_to riferiti all’ora di avvio del run, inizio incluso e fine esclusa; tz_offset sposta solo i confini dei giorni; data_app / triggered_by restringono l’ambito), con la proprietà invertita da “run che ho avviato” ad “app di mia proprietà” (incluse le app con zero release).
Le ripartizioni per giorno / ora / app / canale derivano da bucket orari accumulati al raggiungimento dello stato terminale, quindi qualsiasi intervallo e offset di ore intere restano esatti ed economici. Le ripartizioni per stato / versione / errore vengono calcolate su richiesta dai dettagli dei run, quindi entrambi i limiti sono obbligatori e l’intervallo può coprire al massimo 92 giorni (400 range-too-wide). I gruppi di errore coprono solo i run che hanno un errore; ogni gruppo include il messaggio di errore più recente come sample_message. I run di debug dell’autore sono esclusi per impostazione predefinita; le sonde di salute della piattaforma non vengono mai conteggiate. Il successo include il successo parziale; i run annullati restano fuori dal denominatore del tasso di successo; le metriche senza run terminati valgono null. amount è il costo dei dati pagato dai chiamanti per questi run, non il ricavo liquidato del publisher.
I gruppi per giorno / ora sono in ordine crescente (le chiavi hour sono orari locali YYYY-MM-DDTHH:00 secondo tz_offset, senza suffisso di fuso orario). Gli altri gruppi sono in ordine decrescente per numero di run. App sconosciute o di altri utenti in data_app restituiscono 404.
totals.callers è il numero di utenti chiamanti distinti nell’intervallo, ricavato dai dettagli dei run, ed è impostato solo quando l’intervallo è delimitato e copre al massimo 92 giorni. group_by=caller ripartisce per chiamante una singola app privata o condivisa: l’autore (caller_kind=owner) e gli utenti attualmente nella grant list (grantee) compaiono con il loro nome utente attuale; tutti gli altri (ex grantee, chiamanti di un periodo pubblico) confluiscono in un unico gruppo other. Le app pubbliche o più app restituiscono 400 caller-group-unavailable: i chiamanti delle app pubbliche restano anonimi e vengono solo conteggiati.
Richiesta
Parametri di query
string
predefinito:"day"
Una o due dimensioni, separate da virgola:
day / hour / data_app / triggered_by / state / version / error / caller (per esempio day,data_app). day e hour non si possono combinare; state / version / error / caller richiedono un intervallo delimitato di al massimo 92 giorni; caller richiede inoltre esattamente un’app privata o condivisa. Predefinito day.string[]
Limita a queste app (
<username>/<app_name>, ripetibile). Predefinito: tutte le tue app.string
Inizio inclusivo.
string
Fine esclusiva.
integer
predefinito:"0"
Offset di fuso orario in minuti per i bucket giornalieri / orari. Usa
480 per l’ora standard della Cina. I bucket hanno granularità oraria; gli offset di mezz’ora vengono arrotondati all’ora.Intervallo da -720 a 840.string
Limita a un solo canale di chiamata (
api / sdk / mcp / web e così via).boolean
predefinito:"False"
Se includere le run di debug dell’autore.
boolean
predefinito:"False"
Restituisce anche
previous_totals per la finestra di pari durata immediatamente precedente a created_from. Richiede entrambi i limiti.Esempio di richiesta
Risposta
200 successo
data. Campi:
object
obbligatorio
L’intervallo e l’offset effettivamente usati.
string
Valuta.
object
obbligatorio
Totali dell’intervallo.
object
Totali della finestra precedente di pari durata quando
compare=true.string
Dimensione/i effettivamente usata/e.
object[]
Righe di gruppo. Ogni riga riporta le stesse metriche di
totals più le chiavi di dimensione (day / hour / namespace + app_name / channel / state / version / error_code + error_category + sample_message + last_seen_at / username + caller_kind). Le chiavi non usate valgono null.Errori
Le risposte di errore usano
{"error": {code, category, message, retryable}}. Vedi Errori.