Saltar al contenido

Campañas

Campañas y sus métricas.

Listar campañas

GET/v1/campaigns

Scope necesario: read o full. Una clave full incluye send y read.

Campañas de la organización (sea cual sea el entorno de la clave), de la más reciente a la más antigua, con sus métricas: destinatarios, enviados, entregados, rebotes, quejas, aperturas, clics, bajas y tasas. Filtro status; paginación por cursor. 60 consultas por minuto y clave (compartidas con /v1/stats).

Parámetros

CampoDescripción
cursorstring · query Cursor opaco: usa el nextCursor de la página anterior con los mismos filtros.
limitnumber · query Elementos por página (1-100, 25 por defecto).
statusstring · query valores: draft | scheduled | sending | sent | cancelled | paused | failed

Respuestas

  • 200
    CampoDescripción
    data[]object[] · obligatorio
    data[].idstring · obligatorio
    data[].objectstring · obligatoriovalores: campaign
    data[].namestring · obligatorio
    data[].statusstring · obligatoriovalores: draft | scheduled | sending | sent | cancelled | paused | failed
    data[].subjectstring | null · obligatorio
    data[].fromNamestring | null · obligatorio
    data[].fromEmailstring | null · obligatorio
    data[].scheduledAtstring | null · obligatorio
    data[].sendStartedAtstring | null · obligatorio
    data[].sendFinishedAtstring | null · obligatorio
    data[].createdAtstring · obligatorio
    data[].updatedAtstring · obligatorio
    data[].deferReasonstring | null · obligatorioPor qué el envío está aplazado, si lo está.valores: daily_limit | quota
    data[].trackingAvailableboolean · obligatorioHay seguimiento de aperturas y clics en esta campaña.
    data[].metricsobject · obligatorio
    data[].metrics.recipientsnumber · obligatorioDestinatarios de la campaña (congelados al confirmar).
    data[].metrics.sentnumber · obligatorioEntregados al proveedor.
    data[].metrics.deliverednumber · obligatorioCon evidencia de entrega.
    data[].metrics.bouncednumber · obligatorio
    data[].metrics.complainednumber · obligatorio
    data[].metrics.openednumber · obligatorioAperturas únicas.
    data[].metrics.openedTotalnumber · obligatorioAperturas totales.
    data[].metrics.clickednumber · obligatorioClics únicos.
    data[].metrics.clickedTotalnumber · obligatorioClics totales.
    data[].metrics.unsubscribednumber · obligatorio
    data[].metrics.ratesobject · obligatorio
    nextCursorstring | null · obligatorio

Ejemplo

bash
curl "https://api.vemudo.com/v1/campaigns?status=sent" -H "Authorization: Bearer $VEMUDO_API_KEY"

Consultar una campaña

GET/v1/campaigns/{id}

Scope necesario: read o full. Una clave full incluye send y read.

Datos de la campaña, sus métricas y los enlaces más clicados. No incluye el contenido ni la lista de destinatarios. Id inexistente, de otra organización o mal formado: 404 not_found.

Parámetros

CampoDescripción
idstring · ruta · obligatorio

Respuestas

  • 200
    CampoDescripción
    idstring · obligatorio
    objectstring · obligatoriovalores: campaign
    namestring · obligatorio
    statusstring · obligatoriovalores: draft | scheduled | sending | sent | cancelled | paused | failed
    subjectstring | null · obligatorio
    fromNamestring | null · obligatorio
    fromEmailstring | null · obligatorio
    scheduledAtstring | null · obligatorio
    sendStartedAtstring | null · obligatorio
    sendFinishedAtstring | null · obligatorio
    createdAtstring · obligatorio
    updatedAtstring · obligatorio
    deferReasonstring | null · obligatorioPor qué el envío está aplazado, si lo está.valores: daily_limit | quota
    trackingAvailableboolean · obligatorioHay seguimiento de aperturas y clics en esta campaña.
    metricsobject · obligatorio
    metrics.recipientsnumber · obligatorioDestinatarios de la campaña (congelados al confirmar).
    metrics.sentnumber · obligatorioEntregados al proveedor.
    metrics.deliverednumber · obligatorioCon evidencia de entrega.
    metrics.bouncednumber · obligatorio
    metrics.complainednumber · obligatorio
    metrics.openednumber · obligatorioAperturas únicas.
    metrics.openedTotalnumber · obligatorioAperturas totales.
    metrics.clickednumber · obligatorioClics únicos.
    metrics.clickedTotalnumber · obligatorioClics totales.
    metrics.unsubscribednumber · obligatorio
    metrics.ratesobject · obligatorio
    metrics.rates.deliverynumber | null · obligatorio% entregados sobre enviados.
    metrics.rates.bouncenumber | null · obligatorio% rebotados sobre enviados.
    metrics.rates.complaintnumber | null · obligatorio% quejas sobre entregados.
    metrics.rates.opennumber | null · obligatorio% aperturas únicas sobre entregados (null sin seguimiento).
    metrics.rates.clicknumber | null · obligatorio% clics únicos sobre entregados (null sin seguimiento).
    metrics.rates.unsubscribenumber | null · obligatorio% bajas sobre entregados.
    replyTostring | null · obligatorio
    preheaderstring | null · obligatorio
    scheduleTimeZonestring | null · obligatorio
    confirmedAtstring | null · obligatorio
    links[]object[] · obligatorioEnlaces más clicados (hasta 20).
    links[].idstring · obligatorio
    links[].urlstring · obligatorio
    links[].labelstring · obligatorio
    links[].clickedUniquenumber · obligatorioClics únicos.
    links[].clickedTotalnumber · obligatorioClics totales.
  • 404
    Campaña no encontrada.

Ejemplo

bash
curl https://api.vemudo.com/v1/campaigns/$ID \
  -H "Authorization: Bearer $VEMUDO_API_KEY"