Engagements

Evaluation projects that group conversations. Create and manage engagements to organize your quality assessments and analysis workflows.

Endpoints

Method	Endpoint	Description	Scope
GET	/engagements	List all engagements	engagements:read
GET	/engagements/{id}	Get a single engagement by ID	engagements:read
POST	/engagements	Create a new engagement	engagements:write
PATCH	/engagements/{id}	Update an existing engagement	engagements:write

Create Engagement

Request body for POST /engagements

Field	Type	Required	Description
name	string	Yes	Name of the engagement
description	string	No	Description of the engagement
type	string	Yes	Engagement type

Update Engagement

Request body for PATCH /engagements/{id} — all fields are optional.

Field	Type	Description
name	string	Updated engagement name
description	string	Updated description
status	string	Updated status

Example Requests

List all engagements:

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

Create a new 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"
  }'

Update an 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"
  }'

Example Response

{
  "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
}

More engagement features coming soon

Engagement archiving, bulk operations, and engagement template APIs are being developed.

Request API Access