Skip to main content
GET
/
v1
/
teams
/
{team_id}
/
usage
/
analytics
Get Team Analytics
curl --request GET \
  --url https://api.dataraven.io/v1/teams/{team_id}/usage/analytics \
  --header 'Authorization: Bearer <token>'
{
  "team_id": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "group_by": "<string>",
  "summary": {
    "total_executions": 123,
    "completed": 123,
    "failed": 123,
    "cancelled": 123,
    "manual": 123,
    "scheduled": 123,
    "api": 123,
    "error_rate": 123,
    "total_files_transferred": 123,
    "total_files_deleted": 123,
    "total_checks": 123,
    "total_bytes_transferred": 123,
    "avg_duration_seconds": 123
  },
  "time_series": [
    {
      "period": "<string>",
      "executions": 0,
      "completed": 0,
      "failed": 0,
      "manual": 0,
      "scheduled": 0,
      "bytes_transferred": 0,
      "files_transferred": 0,
      "files_deleted": 0,
      "files_checked": 0,
      "files_renamed": 0,
      "errors": 0
    }
  ],
  "top_errors": [
    {
      "task_id": "<string>",
      "task_name": "<string>",
      "error_count": 123,
      "total_executions": 123,
      "error_rate": 123
    }
  ],
  "task_breakdown": [
    {
      "task_id": "<string>",
      "task_name": "<string>",
      "task_type": "<string>",
      "executions": 123,
      "completed": 123,
      "failed": 123,
      "bytes_transferred": 123,
      "files_transferred": 123,
      "avg_duration_seconds": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

team_id
string<uuid>
required

Query Parameters

start_date
string<date> | null

Start date (YYYY-MM-DD)

end_date
string<date> | null

End date (YYYY-MM-DD)

range
string | null

Quick pick: mtd, 3m, 6m, 1y

group_by
string
default:day

Grouping: day, week, month

task_id
string<uuid> | null

Filter to a specific task

status
string | null

Filter by execution status

Response

Successful Response

Full analytics response for the usage analytics dashboard.

team_id
string
required
start_date
string
required

Effective start date (YYYY-MM-DD)

end_date
string
required

Effective end date (YYYY-MM-DD)

group_by
string
required

Grouping used: day | week | month

summary
AnalyticsSummary · object
required

Aggregate metrics over a date range.

time_series
TimeSeriesBucket · object[]
required
top_errors
TaskErrorSummary · object[]
required
task_breakdown
TaskBreakdown · object[]
required