Saltar al contenido

Segmentos

Segmentos guardados y su definición.

Listar segmentos

GET/v1/segments

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

Segmentos guardados de la organización con su definición y el recuento actual de contactos (count). El recuento es una consulta cara: 60 consultas por minuto y clave (compartidas con /v1/stats y /v1/account). Máximo 100 segmentos: no hay paginación.

Respuestas

  • 200
    CampoDescripción
    data[]object[] · obligatorio
    data[].idstring · obligatorio
    data[].objectstring · obligatoriovalores: segment
    data[].namestring · obligatorio
    data[].definitionobject · obligatorio
    data[].definition.versionnumber · obligatoriovalores: 1
    data[].definition.matchstring · obligatorioall: todas las reglas; any: alguna.valores: all | any
    data[].definition.rules[]object[] · obligatorio
    data[].countnumber | null · obligatorioContactos que cumplen el segmento ahora (suscritos y sin bloqueo); null si el segmento ya no es válido.
    data[].validboolean · obligatoriofalse si referencia una lista, etiqueta o campo que ya no existe.
    data[].errorCodestring | null · obligatorio
    data[].createdAtstring · obligatorio
    data[].updatedAtstring · obligatorio
    data[].countedAtstring · obligatorioCuándo se calculó count.
    nextCursorstring | null · obligatorio

Ejemplo

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

Consultar un segmento

GET/v1/segments/{id}

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

Id inexistente, borrado, 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: segment
    namestring · obligatorio
    definitionobject · obligatorio
    definition.versionnumber · obligatoriovalores: 1
    definition.matchstring · obligatorioall: todas las reglas; any: alguna.valores: all | any
    definition.rules[]object[] · obligatorio
    definition.rules[].fieldstring · obligatorioej.: email
    definition.rules[].operatorstring · obligatorioej.: contains
    definition.rules[].valueany
    countnumber | null · obligatorioContactos que cumplen el segmento ahora (suscritos y sin bloqueo); null si el segmento ya no es válido.
    validboolean · obligatoriofalse si referencia una lista, etiqueta o campo que ya no existe.
    errorCodestring | null · obligatorio
    createdAtstring · obligatorio
    updatedAtstring · obligatorio
    countedAtstring · obligatorioCuándo se calculó count.
  • 404
    Segmento no encontrado.

Ejemplo

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