Skip to main content
GET
/
agent-tasks
/
analytics
Get Agent Analytics
curl --request GET \
  --url https://api.beamstudio.ai/agent-tasks/analytics \
  --header 'current-workspace-id: <current-workspace-id>' \
  --header 'x-api-key: <api-key>'
{
  "currentPeriod": {
    "totalTasks": 123,
    "completedTasks": 123,
    "failedTasks": 123,
    "averageEvaluationScore": 123,
    "averageRuntimeSeconds": 123,
    "totalRuntimeSeconds": 123,
    "positiveFeedbackCount": 123,
    "consentRequiredCount": 123,
    "negativeFeedbackCount": 123
  },
  "metricsDelta": {
    "totalTasksDelta": "<string>",
    "completedTasksDelta": "<string>",
    "failedTasksDelta": "<string>",
    "consentRequiredTasksDelta": "<string>",
    "averageRuntimeSecondsDelta": "<string>",
    "totalRuntimeSecondsDelta": "<string>",
    "averageEvaluationScoreDelta": "<string>"
  },
  "taskAndEvaluationChart": [
    {
      "date": "<string>",
      "completedCount": 123,
      "failedCount": 123,
      "averageEvaluationScore": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

Headers

current-workspace-id
string
required

Query Parameters

startDate
string
required
endDate
string
required
agentId
string
required

Response

200 - application/json

Analytics data retrieved successfully

currentPeriod
object
required
metricsDelta
object
required
taskAndEvaluationChart
object[]
required