Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Operaciones de campaña

Listar los pipelines de una campaña

Sirve para seguir las operaciones masivas sobre los grupos de una campaña (cambios de nombre, foto, descripción, administradores o participantes), filtrando por estado o tipo de acción.

GET
/v1/campaigns/{campaign}/pipelines

Permiso requerido: communities:read (Leer)

Con API key: la respuesta siempre viene paginada. Tamaño de página: per_page (por defecto 25, máximo 100; un valor mayor, menor que 1 o no entero responde 422). Orden: orderBy acepta id, name, group_index, created_at, updated_at; dirección orderByMethod: asc o desc. Otro valor responde 422.

Autorización

http
headerAuthorizationBearer <clave>

Tu API key de Funnelchat, enviada en cada llamada como Authorization: Bearer <id>|fc_live_....

Parámetros de la ruta

campaign*integer

The campaign ID

Parámetros de consulta

page?integer
Rango1 <= value
per_page?integer
Rango1 <= value <= 100
status?string
Valor en"scheduled""running""completed""failed""cancelled"
action_type?string
Valor en"add""new""name""description""photo""participants""remove-participants""administrators""remove-administrators""join_group""members_can_send_messages""remove_group"
orderBy?string
Valor en"id""name""group_index""created_at""updated_at"
orderByMethod?string
Valor en"asc""desc"

Cuerpo de la respuesta

application/json
  1. response
campaign*
data*array<>
meta*
curl -X GET "https://example.com/v1/campaigns/0/pipelines"
{  "campaign": {    "id": 0,    "name": "string"  },  "data": [    {      "id": 0,      "pipeline_id": "string",      "name": "string",      "group_index": 0,      "created_at": "string",      "summary": {        "total_actions": 0,        "total_action_groups": "string",        "status_counts": {          "scheduled": "string",          "running": "string",          "completed": "string",          "failed": "string",          "cancelled": "string",          "pending_confirmation": "string",          "skipped": "string"        },        "progress_percentage": 0      }    }  ],  "meta": {    "current_page": 0,    "last_page": 0,    "per_page": 0,    "total": 0,    "from": 0,    "to": 0  }}

Listar los grupos de una campaña GET

Usalo para listar los grupos de una campaña con su estado, origen y conexión del administrador, por ejemplo para detectar grupos llenos o desconectados.

Ver un pipeline GET

Usalo para ver el avance de una operación masiva: cuántas acciones están programadas, en curso, completadas o fallidas, y el porcentaje de progreso.