Engagements

Proyectos de evaluacion que agrupan conversaciones. Crea y gestiona engagements para organizar tus evaluaciones de calidad y flujos de analisis.

Endpoints

Metodo	Endpoint	Descripcion	Scope
GET	/engagements	Listar todos los engagements	engagements:read
GET	/engagements/{id}	Obtener un engagement por ID	engagements:read
POST	/engagements	Crear un nuevo engagement	engagements:write
PATCH	/engagements/{id}	Actualizar un engagement existente	engagements:write

Crear Engagement

Cuerpo de la solicitud para POST /engagements

Campo	Tipo	Requerido	Descripcion
name	string	Si	Nombre del engagement
description	string	No	Descripcion del engagement
type	string	Si	Tipo de engagement

Actualizar Engagement

Cuerpo de la solicitud para PATCH /engagements/{id} — todos los campos son opcionales.

Campo	Tipo	Descripcion
name	string	Nombre del engagement actualizado
description	string	Descripcion actualizada
status	string	Estado actualizado

Ejemplos de Solicitudes

Listar todos los engagements:

curl https://api.auralytik.com/v1/engagements \
  -H "Authorization: Bearer YOUR_API_KEY"

Crear un nuevo engagement:

curl -X POST https://api.auralytik.com/v1/engagements \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q1 Quality Review",
    "description": "First quarter quality evaluation project",
    "type": "quality_review"
  }'

Actualizar un engagement:

curl -X PATCH https://api.auralytik.com/v1/engagements/eng_456 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q1 Quality Review - Updated",
    "status": "completed"
  }'

Ejemplo de Respuesta

{
  "data": [
    {
      "id": "eng_456",
      "name": "Q1 Quality Review",
      "description": "First quarter quality evaluation project",
      "type": "quality_review",
      "status": "active",
      "evaluationCount": 142,
      "createdAt": "2024-01-10T09:00:00Z",
      "updatedAt": "2024-01-15T14:30:00Z"
    }
  ],
  "page": 1,
  "pageSize": 25,
  "totalCount": 5
}

Mas funciones de engagements proximamente

APIs de archivado de engagements, operaciones masivas y plantillas de engagements estan en desarrollo.

Solicitar Acceso API