Analyze Tickets

curl -X POST https://api.example.com/api/cs-qa/v1/analyze \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tickets": [
      {
        "ticket_id": "123",
        "subject": "Need help",
        "description": "Having issues with login",
        "status": "open",
        "priority": "high"
      }
    ]
  }'

import requests

tickets_payload = {
    "tickets": [{
        "ticket_id": "123",
        "subject": "Need help",
        "description": "Having issues with login",
        "status": "open",
        "priority": "high"
    }]
}

response = requests.post(
    "https://api.example.com/api/cs-qa/v1/analyze",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json=tickets_payload
)
batch_id = response.json()["batch_id"]

{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_tickets": 123,
  "processed_tickets": 123,
  "failed_tickets": 123,
  "status": "pending",
  "results": [
    {
      "ticket_id": "<string>",
      "agent_id": "<string>",
      "parameter_name": "<string>",
      "reason": "<string>",
      "value": "<string>"
    }
  ],
  "errors": {}
}

{
  "detail": "Invalid API key"
}

{
  "detail": [
    {}
  ]
}

{
  "detail": "Too many requests. Please try again later."
}

{
  "detail": "Internal server error"
}

POST

api

cs-qa

analyze

curl -X POST https://api.example.com/api/cs-qa/v1/analyze \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tickets": [
      {
        "ticket_id": "123",
        "subject": "Need help",
        "description": "Having issues with login",
        "status": "open",
        "priority": "high"
      }
    ]
  }'

import requests

tickets_payload = {
    "tickets": [{
        "ticket_id": "123",
        "subject": "Need help",
        "description": "Having issues with login",
        "status": "open",
        "priority": "high"
    }]
}

response = requests.post(
    "https://api.example.com/api/cs-qa/v1/analyze",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json=tickets_payload
)
batch_id = response.json()["batch_id"]

{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_tickets": 123,
  "processed_tickets": 123,
  "failed_tickets": 123,
  "status": "pending",
  "results": [
    {
      "ticket_id": "<string>",
      "agent_id": "<string>",
      "parameter_name": "<string>",
      "reason": "<string>",
      "value": "<string>"
    }
  ],
  "errors": {}
}

{
  "detail": "Invalid API key"
}

{
  "detail": [
    {}
  ]
}

{
  "detail": "Too many requests. Please try again later."
}

{
  "detail": "Internal server error"
}

Process Flow

Validates the API key and gets account_id
Generates a batch_id
Creates a batch record in database
Queues the processing task
Returns the batch_id for tracking

curl -X POST https://api.example.com/api/cs-qa/v1/analyze \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tickets": [
      {
        "ticket_id": "123",
        "subject": "Need help",
        "description": "Having issues with login",
        "status": "open",
        "priority": "high"
      }
    ]
  }'

import requests

tickets_payload = {
    "tickets": [{
        "ticket_id": "123",
        "subject": "Need help",
        "description": "Having issues with login",
        "status": "open",
        "priority": "high"
    }]
}

response = requests.post(
    "https://api.example.com/api/cs-qa/v1/analyze",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json=tickets_payload
)
batch_id = response.json()["batch_id"]

Authorizations

Authorization

string

header

required

Enter your API key

Body

application/json

tickets

TicketData · object[]

required

Show child attributes

schema_id

integer | null

Response

Successful Response

batch_id

string<uuid>

required

total_tickets

integer

required

processed_tickets

integer

required

failed_tickets

integer

required

status

string

default:pending

results

QAResult · object[] | null

Show child attributes

errors

Errors · object | null

Show child attributes

Test Connection Check Batch Status

Getting Started

Common Features

User Research

Image Extraction

Freshdesk Quality Assistant

Process Flow

Authorizations

Body

Response

​Process Flow

Authorizations

Body

Response

Process Flow