Salt la conținutul principal
POST
/
api
/
v1
/
CascadeAnalytics
Obține Analytics pentru Cascade
curl --request POST \
  --url https://server.codeium.com/api/v1/CascadeAnalytics \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "start_timestamp": "<string>",
  "end_timestamp": "<string>",
  "emails": [
    {}
  ],
  "ide_types": [
    {}
  ],
  "query_requests": [
    {}
  ]
}
'
import requests

url = "https://server.codeium.com/api/v1/CascadeAnalytics"

payload = {
"service_key": "<string>",
"group_name": "<string>",
"start_timestamp": "<string>",
"end_timestamp": "<string>",
"emails": [{}],
"ide_types": [{}],
"query_requests": [{}]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
service_key: '<string>',
group_name: '<string>',
start_timestamp: '<string>',
end_timestamp: '<string>',
emails: [{}],
ide_types: [{}],
query_requests: [{}]
})
};

fetch('https://server.codeium.com/api/v1/CascadeAnalytics', 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://server.codeium.com/api/v1/CascadeAnalytics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service_key' => '<string>',
'group_name' => '<string>',
'start_timestamp' => '<string>',
'end_timestamp' => '<string>',
'emails' => [
[

]
],
'ide_types' => [
[

]
],
'query_requests' => [
[

]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://server.codeium.com/api/v1/CascadeAnalytics"

payload := strings.NewReader("{\n \"service_key\": \"<string>\",\n \"group_name\": \"<string>\",\n \"start_timestamp\": \"<string>\",\n \"end_timestamp\": \"<string>\",\n \"emails\": [\n {}\n ],\n \"ide_types\": [\n {}\n ],\n \"query_requests\": [\n {}\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://server.codeium.com/api/v1/CascadeAnalytics")
.header("Content-Type", "application/json")
.body("{\n \"service_key\": \"<string>\",\n \"group_name\": \"<string>\",\n \"start_timestamp\": \"<string>\",\n \"end_timestamp\": \"<string>\",\n \"emails\": [\n {}\n ],\n \"ide_types\": [\n {}\n ],\n \"query_requests\": [\n {}\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://server.codeium.com/api/v1/CascadeAnalytics")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_key\": \"<string>\",\n \"group_name\": \"<string>\",\n \"start_timestamp\": \"<string>\",\n \"end_timestamp\": \"<string>\",\n \"emails\": [\n {}\n ],\n \"ide_types\": [\n {}\n ],\n \"query_requests\": [\n {}\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "queryResults": [
    {
      "cascadeLines": {
        "cascadeLines": [
          {
            "day": "<string>",
            "linesSuggested": "<string>",
            "linesAccepted": "<string>"
          }
        ]
      },
      "cascadeRuns": {
        "cascadeRuns": [
          {
            "day": "<string>",
            "model": "<string>",
            "mode": "<string>",
            "messagesSent": "<string>",
            "cascadeId": "<string>",
            "promptsUsed": "<string>"
          }
        ]
      },
      "cascadeToolUsage": {
        "cascadeToolUsage": [
          {
            "tool": "<string>",
            "count": "<string>"
          }
        ]
      }
    }
  ]
}

Prezentare generală

Obțineți date de Analytics specifice Cascade, inclusiv linii sugerate/acceptate, utilizarea modelului AI, consumul de credite și statistici privind utilizarea instrumentelor.

Cerere

service_key
string
obligatoriu
Cheia ta de serviciu cu permisiuni „Teams Read-only”
group_name
string
Filtrează rezultatele la utilizatorii dintr-un grup anume. Nu poate fi folosit împreună cu parametrul emails.
start_timestamp
string
Ora de început în format RFC 3339 (de ex. „2023-01-01T00:00:00Z”)
end_timestamp
string
Ora de sfârșit în format RFC 3339 (de ex. „2023-12-31T23:59:59Z”)
emails
array
Array de adrese de email pentru filtrarea rezultatelor. Nu poate fi folosit împreună cu parametrul group_name.
ide_types
array
Filtrează după tipul de IDE. Opțiuni disponibile:
  • "editor" - Windsurf Editor
  • "jetbrains" - JetBrains Plugin
Dacă este omis, returnează date pentru ambele IDE-uri.
query_requests
array
obligatoriu
Array de interogări ale surselor de date de executat. Fiecare obiect trebuie să conțină una dintre sursele de date acceptate.

Surse de date

cascade_lines

Interogare pentru liniile zilnice Cascade sugerate și acceptate.
{
  "cascade_lines": {}
}
Câmpuri de răspuns:
  • day - Dată în format RFC 3339
  • linesSuggested - Număr de linii sugerate
  • linesAccepted - Număr de linii acceptate

cascade_runs

Interogare a utilizării modelului AI, a consumului de credite și a datelor despre moduri.
{
  "cascade_runs": {}
}
Câmpuri de răspuns:
  • day - Dată în format RFC 3339
  • model - Numele modelului AI utilizat
  • mode - Mod Cascade (consultați modurile de mai jos)
  • messagesSent - Numărul de mesaje trimise
  • cascadeId - ID unic de conversație
  • promptsUsed - Credite consumate (în cenți)
Moduri Cascade:
  • CONVERSATIONAL_PLANNER_MODE_DEFAULT - Mod de scriere
  • CONVERSATIONAL_PLANNER_MODE_READ_ONLY - Mod de citire
  • CONVERSATIONAL_PLANNER_MODE_NO_TOOL - Mod vechi
  • UNKNOWN - Mod necunoscut

cascade_tool_usage

Interogare pentru statistici privind utilizarea uneltelor (totaluri agregate).
{
  "cascade_tool_usage": {}
}
Câmpuri de răspuns:
  • tool - Identificatorul instrumentului (consultați mapările instrumentelor de mai jos)
  • count - Numărul de utilizări ale instrumentului

Mapări pentru utilizarea uneltelor

Tool IdentifierDisplay Name
CODE_ACTIONEditare cod
VIEW_FILEVizualizare fișier
RUN_COMMANDExecutare Command
FINDUnealtă de căutare
GREP_SEARCHCăutare grep
VIEW_FILE_OUTLINEVizualizare structură fișier
MQUERYRiptide
WORKFLOWS_USEDFluxuri de lucru utilizate
LIST_DIRECTORYListare director
MCP_TOOLInstrument MCP
PROPOSE_CODEPropunere de cod
SEARCH_WEBCăutare pe web
MEMORYMemorie
PROXY_WEB_SERVERPrevizualizare în browser
DEPLOY_WEB_APPImplementare aplicație web

Exemplu de solicitare

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "group_name": "engineering_team",
  "start_timestamp": "2025-01-01T00:00:00Z",
  "end_timestamp": "2025-01-02T00:00:00Z",
  "emails": ["user1@windsurf.com", "user2@windsurf.com"],
  "ide_types": ["editor"],
  "query_requests": [
    {
      "cascade_lines": {}
    },
    {
      "cascade_runs": {}
    },
    {
      "cascade_tool_usage": {}
    }
  ]
}' \
https://server.codeium.com/api/v1/CascadeAnalytics

Răspuns

queryResults
array
Listă de rezultate ale interogărilor, câte unul pentru fiecare cerere de interogare

Exemplu de răspuns

{
  "queryResults": [
    {
      "cascadeLines": {
        "cascadeLines": [
          {
            "day": "2025-05-01T00:00:00Z",
            "linesSuggested": "206",
            "linesAccepted": "157"
          },
          {
            "day": "2025-05-02T00:00:00Z",
            "linesSuggested": "16"
          }
        ]
      }
    },
    {
      "cascadeRuns": {
        "cascadeRuns": [
          {
            "day": "2025-05-01T00:00:00Z",
            "model": "Claude 3.7 Sonnet (Thinking)",
            "mode": "CONVERSATIONAL_PLANNER_MODE_DEFAULT",
            "messagesSent": "1",
            "cascadeId": "0d35c1f7-0a85-41d0-ac96-a04cd2d64444"
          }
        ]
      }
    },
    {
      "cascadeToolUsage": {
        "cascadeToolUsage": [
          {
            "tool": "CODE_ACTION",
            "count": "15"
          },
          {
            "tool": "LIST_DIRECTORY",
            "count": "20"
          }
        ]
      }
    }
  ]
}

Note

  • API-ul returnează date brute care pot conține valori „UNKNOWN”
  • Pentru analiza metricilor, agregați în funcție de câmpuri specifice de interes (de ex., suma promptsUsed pentru modele de utilizare)
  • Datele privind modul și promptul pot fi împărțite în mai multe intrări
  • Consumul de credite (promptsUsed) este returnat în cenți (100 = 1 credit)