Get Agent Analytics

curl --request GET \
  --url https://api.beamstudio.ai/agent-tasks/analytics \
  --header 'Authorization: Bearer <token>' \
  --header 'current-workspace-id: <current-workspace-id>'

{
  "currentPeriod": {
    "totalTasks": 150,
    "completedTasks": 135,
    "failedTasks": 15,
    "averageEvaluationScore": 87.5,
    "averageRuntimeSeconds": 45.7,
    "totalRuntimeSeconds": 6855,
    "positiveFeedbackCount": 120,
    "consentRequiredCount": 25,
    "negativeFeedbackCount": 10
  },
  "metricsDelta": {
    "totalTasksDelta": "+15.5%",
    "completedTasksDelta": "+12.3%",
    "failedTasksDelta": "-5.2%",
    "consentRequiredTasksDelta": "+3.1%",
    "averageRuntimeSecondsDelta": "-8.7%",
    "totalRuntimeSecondsDelta": "+10.2%",
    "averageEvaluationScoreDelta": "+4.5%"
  },
  "taskAndEvaluationChart": [
    {
      "date": "2024-01-15",
      "completedCount": 42,
      "failedCount": 8,
      "averageEvaluationScore": 87.5
    }
  ]
}

GET

agent-tasks

analytics

Get Agent Analytics

curl --request GET \
  --url https://api.beamstudio.ai/agent-tasks/analytics \
  --header 'Authorization: Bearer <token>' \
  --header 'current-workspace-id: <current-workspace-id>'

{
  "currentPeriod": {
    "totalTasks": 150,
    "completedTasks": 135,
    "failedTasks": 15,
    "averageEvaluationScore": 87.5,
    "averageRuntimeSeconds": 45.7,
    "totalRuntimeSeconds": 6855,
    "positiveFeedbackCount": 120,
    "consentRequiredCount": 25,
    "negativeFeedbackCount": 10
  },
  "metricsDelta": {
    "totalTasksDelta": "+15.5%",
    "completedTasksDelta": "+12.3%",
    "failedTasksDelta": "-5.2%",
    "consentRequiredTasksDelta": "+3.1%",
    "averageRuntimeSecondsDelta": "-8.7%",
    "totalRuntimeSecondsDelta": "+10.2%",
    "averageEvaluationScoreDelta": "+4.5%"
  },
  "taskAndEvaluationChart": [
    {
      "date": "2024-01-15",
      "completedCount": 42,
      "failedCount": 8,
      "averageEvaluationScore": 87.5
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

current-workspace-id

string

required

Query Parameters

startDate

string<date-time>

required

The start date for the analytics period. The date will be normalized to the beginning of the day (00:00:00) in the provided timezone. Used to filter task execution data for analytics calculation.

Example:

"2024-01-01T00:00:00Z"

endDate

string<date-time>

required

The end date for the analytics period. The date will be normalized to the end of the day (23:59:59) in the provided timezone. Analytics will include all tasks executed between startDate and endDate inclusive.

Example:

"2024-01-31T23:59:59Z"

agentId

string<uuid>

required

The unique identifier of the agent to retrieve analytics for. Analytics will be calculated only for tasks executed by this specific agent during the specified date range.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

200 - application/json

Analytics data retrieved successfully

currentPeriod

object

required

Performance metrics for the requested analytics period including task counts, success rates, runtime statistics, and user feedback

Show child attributes

currentPeriod.totalTasks

number

required

The total number of tasks executed during this analytics period

Example:

150

currentPeriod.completedTasks

number

required

The number of tasks that completed successfully during this period

Example:

135

currentPeriod.failedTasks

number

required

The number of tasks that failed during this period

Example:

15

currentPeriod.averageEvaluationScore

number

required

The average evaluation score across all tasks in this period (0-100 scale)

Example:

87.5

currentPeriod.averageRuntimeSeconds

number

required

The average runtime in seconds per task during this period

Example:

45.7

currentPeriod.totalRuntimeSeconds

number

required

The total runtime in seconds for all tasks during this period

Example:

6855

currentPeriod.positiveFeedbackCount

number

required

The number of tasks that received positive user feedback during this period

Example:

120

The number of tasks that required user consent or approval during this period

Example:

25

currentPeriod.negativeFeedbackCount

number

required

The number of tasks that received negative user feedback during this period

Example:

10

metricsDelta

object

required

Percentage changes in key metrics compared to the previous period of the same length. Shows growth or decline trends across all tracked metrics.

Show child attributes

metricsDelta.totalTasksDelta

string

required

The percentage change in total tasks compared to the previous period. Positive values indicate growth, negative values indicate decline.

Example:

"+15.5%"

metricsDelta.completedTasksDelta

string

required

The percentage change in completed tasks compared to the previous period

Example:

"+12.3%"

metricsDelta.failedTasksDelta

string

required

The percentage change in failed tasks compared to the previous period

Example:

"-5.2%"

The percentage change in tasks requiring consent compared to the previous period

Example:

"+3.1%"

metricsDelta.averageRuntimeSecondsDelta

string

required

The percentage change in average runtime per task compared to the previous period

Example:

"-8.7%"

metricsDelta.totalRuntimeSecondsDelta

string

required

The percentage change in total runtime compared to the previous period

Example:

"+10.2%"

metricsDelta.averageEvaluationScoreDelta

string

required

The percentage change in average evaluation score compared to the previous period

Example:

"+4.5%"

taskAndEvaluationChart

object[]

required

Time-series data for visualizing task completion trends and evaluation scores over the analytics period. Each element represents a day in the date range.

Show child attributes

taskAndEvaluationChart.date

string<date>

required

The date for this data point in the analytics chart

Example:

"2024-01-15"

taskAndEvaluationChart.completedCount

number

required

The number of completed tasks on this date

Example:

42

taskAndEvaluationChart.failedCount

number

required

The number of failed tasks on this date

Example:

8

taskAndEvaluationChart.averageEvaluationScore

number

required

The average evaluation score for tasks executed on this date (0-100 scale)

Example:

87.5

Create Agent Task Submit User Input

⌘I

API Reference

Authorizations

Headers

Query Parameters

Response