Publishing
Uso del publicador
Cómo se llamaron sus apps publicadas en un periodo: totales más desgloses por día, hora, app, canal, estado, versión, código de error o llamador.
GET
Uso del publicador
GET https://api-datahub.octoparse.com/v1/publisher/usage
Autenticación: se requiere API key (Authorization: Bearer <API Key>).
Cómo se llamaron sus apps en un periodo: totales del rango, más desgloses por día (o hora en rangos cortos), app y canal de llamada (se pueden cruzar dos cualesquiera), o desgloses de diagnóstico por estado terminal, versión o código de error. Es la contraparte del lado publicador de la agregación de facturación: el mismo vocabulario (created_from / created_to por hora de inicio de la ejecución, inicio inclusivo y fin exclusivo; tz_offset solo mueve límites de día; data_app / triggered_by acotan el alcance), con la propiedad invertida de «ejecuciones que inicié» a «apps que poseo» (incluidas apps con cero releases).
Los desgloses día/hora/app/canal salen de buckets horarios acumulados en estado terminal, así que cualquier rango y offset de hora completa se mantienen exactos y baratos. Los desgloses estado/versión/error se calculan bajo demanda desde detalles de ejecución, así que ambos límites son obligatorios y el tramo debe ser de como máximo 92 días (400 range-too-wide). Los grupos de error solo cubren ejecuciones con error; cada grupo incluye el mensaje de error más reciente como sample_message. Las depuraciones del autor se excluyen por defecto; los probes de salud de la plataforma nunca cuentan. El éxito incluye el éxito parcial; las canceladas quedan fuera del denominador de la tasa de éxito; las métricas sin ejecuciones terminales son null. amount es la tarifa de datos que pagaron los llamadores por estas ejecuciones, no el ingreso liquidado del publicador.
Los grupos día/hora ascienden (las claves hour son reloj local YYYY-MM-DDTHH:00 bajo tz_offset, sin sufijo de zona). Los demás grupos descienden por recuento de ejecuciones.
totals.callers es el recuento de usuarios llamadores distintos en el rango, desde detalles de ejecución, y solo se establece cuando el rango está acotado y tiene como máximo 92 días. group_by=caller desglosa una única app privada o compartida por llamador: el autor (caller_kind=owner) y los usuarios actualmente en la lista de grants (grantee) aparecen bajo su username actual; el resto (ex-grantees, llamadores de un periodo público) se fusiona en un grupo other. Apps públicas o varias apps devuelven 400 caller-group-unavailable: los llamadores de apps públicas permanecen anónimos y solo se cuentan.
Solicitud
Parámetros de consulta
string
predeterminado:"day"
Una o dos dimensiones, separadas por comas:
day / hour / data_app / triggered_by / state / version / error / caller (por ejemplo day,data_app). day y hour no se combinan; state / version / error / caller necesitan un rango acotado de como máximo 92 días; caller también exige exactamente una app privada o compartida. Predeterminado day.string[]
Limitar a estas apps (
<username>/<app_name>, repetible). Predeterminado: todas las suyas.string
Inicio inclusivo.
string
Fin exclusivo.
integer
predeterminado:"0"
Offset de zona horaria en minutos para buckets día/hora. Use
480 para la hora estándar de China. Buckets de grano horario; offsets de media hora se redondean a la hora.Rango de -720 a 840.string
Limitar a un canal de llamada (
api / sdk / mcp / web, etc.).boolean
predeterminado:"False"
Si incluir ejecuciones de depuración del autor.
boolean
predeterminado:"False"
También devuelve
previous_totals de la ventana de igual longitud justo antes de created_from. Requiere ambos límites.Ejemplo de solicitud
Respuesta
200 correcto
data. Campos:
object
requerido
El rango y el offset realmente usados.
string
Divisa.
object
requerido
Totales del rango.
object
Totales de la ventana previa de igual longitud cuando
compare=true.string
Dimensión(es) realmente usada(s).
object[]
Filas de grupo. Cada fila lleva las mismas métricas que
totals, más claves de dimensión (day / hour / data_app / triggered_by / state / version / error / caller según group_by).Errores
Las respuestas de error usan
{"error": {code, category, message, retryable}}. Véase Errores.