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>'
import requests

url = "https://api.dataraven.io/v1/teams/{team_id}/usage/analytics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dataraven.io/v1/teams/{team_id}/usage/analytics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dataraven.io/v1/teams/{team_id}/usage/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dataraven.io/v1/teams/{team_id}/usage/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.dataraven.io/v1/teams/{team_id}/usage/analytics")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.dataraven.io/v1/teams/{team_id}/usage/analytics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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