Get Consumption

Get consumption analytics

curl --request GET \
  --url https://server.codeium.com/api/v2alpha/analytics/consumption \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://server.codeium.com/api/v2alpha/analytics/consumption"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://server.codeium.com/api/v2alpha/analytics/consumption', 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/v2alpha/analytics/consumption",
  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://server.codeium.com/api/v2alpha/analytics/consumption"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://server.codeium.com/api/v2alpha/analytics/consumption")

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

{
  "data": [
    {
      "timestamp": "2026-01-15",
      "user_id": "user_abc123",
      "user_email": "alice@example.com",
      "consumption": {
        "prompt_credits": 1250,
        "flex_credits": 340,
        "message_count": 87
      }
    },
    {
      "timestamp": "2026-01-15",
      "user_id": "user_def456",
      "user_email": "bob@example.com",
      "consumption": {
        "prompt_credits": 980,
        "flex_credits": 150,
        "message_count": 52
      }
    }
  ],
  "pagination": {
    "next_page_cursor": null
  },
  "metadata": {
    "billing_strategy": "CREDITS",
    "data_freshness": "2026-01-16T03:00:00Z",
    "query_time_ms": 1423,
    "team_id": "team_abc123"
  }
}

GET

api

v2alpha

analytics

consumption

Get consumption analytics

curl --request GET \
  --url https://server.codeium.com/api/v2alpha/analytics/consumption \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://server.codeium.com/api/v2alpha/analytics/consumption"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://server.codeium.com/api/v2alpha/analytics/consumption', 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/v2alpha/analytics/consumption",
  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://server.codeium.com/api/v2alpha/analytics/consumption"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://server.codeium.com/api/v2alpha/analytics/consumption")

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

{
  "data": [
    {
      "timestamp": "2026-01-15",
      "user_id": "user_abc123",
      "user_email": "alice@example.com",
      "consumption": {
        "prompt_credits": 1250,
        "flex_credits": 340,
        "message_count": 87
      }
    },
    {
      "timestamp": "2026-01-15",
      "user_id": "user_def456",
      "user_email": "bob@example.com",
      "consumption": {
        "prompt_credits": 980,
        "flex_credits": 150,
        "message_count": 52
      }
    }
  ],
  "pagination": {
    "next_page_cursor": null
  },
  "metadata": {
    "billing_strategy": "CREDITS",
    "data_freshness": "2026-01-16T03:00:00Z",
    "query_time_ms": 1423,
    "team_id": "team_abc123"
  }
}

This is a v2 endpoint that uses Bearer token authentication and query parameters, unlike the v1 Analytics API which uses service keys in the request body. See Authentication below.

This endpoint is not intended for real-time usage monitoring. Data is hourly-aggregated and the rate limit is low (10 requests per hour per team). Use it for periodic reporting and bulk export.

Authentication

This endpoint uses Bearer token authentication. Include your token in the Authorization header:

Authorization: Bearer <your_token>

Use either a Devin service user API key with the Use Local Analytics API permission or a Windsurf service key with the Analytics Read permission. See Authentication for how to create each one.

Billing Strategy

The response shape depends on your team’s billing strategy:

Strategy	Populated fields	Description
`CREDITS`	`prompt_credits`, `flex_credits`	Standard Enterprise SaaS teams
`ACU`	`billed_acus`	Teams billed by Agent Compute Units

The message_count field (inside consumption) is always populated regardless of billing strategy.

Grouping and Granularity

Use granularity and group_by to control the shape of returned data:

No granularity or grouping — returns a single aggregated row for the entire date range
granularity=daily — each row includes a timestamp in YYYY-MM-DD format
granularity=monthly — each row includes a timestamp in YYYY-MM format
group_by=user — each row includes a user_id and user_email
group_by=user,model_uid — each row includes user_id, user_email, and model_uid
group_by=ide — each row includes an ide
group_by=ide,ide_version — each row includes ide and ide_version (grouping by ide_version requires ide to also be included)
group_by=os — each row includes an os, such as darwin (macOS), windows, or linux

Pagination

Results are paginated with a default page size of 1,000 rows (max 10,000). When more results are available, the response includes a next_page_cursor in the pagination object. Pass it as the page_cursor query parameter to fetch the next page. Page cursors expire after 24 hours. A follow-up page request does not count as a new query against your rate limit.

Caching

Responses include an ETag header. To avoid redundant data transfer, include the If-None-Match header with the previous ETag value — the server will return 304 Not Modified if the data has not changed.

Rate Limits

This endpoint is rate-limited to 10 requests per hour per team. If you exceed this limit, the server returns 429 Too Many Requests with a Retry-After header. Paginating an earlier query (following a next_page_cursor) does not count against this limit — only the initial query for each report does. The low limit reflects that this endpoint is for periodic reporting, not real-time usage monitoring.

Authorizations

Authorization

string

header

required

A service key with Analytics Read permission, passed as a Bearer token in the Authorization header.

Create a service key in your team settings under the "Service Keys" section.

Headers

If-None-Match

string

ETag value from a previous response. If the data has not changed, the server returns 304 Not Modified.

Query Parameters

start_date

string<date>

required

Start of the date range (inclusive) in YYYY-MM-DD format.

end_date

string<date>

required

End of the date range (inclusive) in YYYY-MM-DD format. The range must not exceed 90 days.

product

enum<string>

required

Product to query consumption for.

Available options:

agent

granularity

enum<string>

Time granularity for grouping results. When specified, each row includes a timestamp field. If omitted, results are aggregated across the entire date range.

Available options:

daily,

monthly

group_by

string

Comma-separated list of dimensions to group results by. Supported dimensions:

user — includes user_id and user_email in each row
model_uid — includes model_uid in each row
ide — includes ide in each row
ide_version — includes ide_version in each row; requires ide to also be included
os — includes os in each row

models

string

Comma-separated list of model UIDs to filter results to.

group_id

string

Filter results to users in a specific group. The service key must have access to this group.

user_id

string

Filter results to a specific user (auth UID).

page_size

integer

default:1000

Maximum number of rows to return per page.

Required range: 1 <= x <= 10000

page_cursor

string

Opaque cursor from a previous response's pagination.next_page_cursor to fetch the next page.

Response

Consumption data returned successfully.

data

object[]

required

Array of consumption data rows.

Show child attributes

pagination

object

required

Show child attributes

metadata

object

required

Show child attributes

Devin Desktop

Agent Command Center

Releases

Windsurf Plugins

Accounts

Security

Authentication

Billing Strategy

Grouping and Granularity

Caching

Rate Limits

Authorizations

Headers

Query Parameters

Response

​Authentication

​Billing Strategy

​Grouping and Granularity

​Pagination

​Caching

​Rate Limits

Authorizations

Headers

Query Parameters

Response

Authentication

Billing Strategy

Grouping and Granularity

Pagination

Caching

Rate Limits