Admin SDK — Querying Analytics

The Admin SDK provides two analytics capabilities: querying request log metrics (automatic API usage data) and managing custom events (track + query). All endpoints require a Service Key.

Language Coverage

Analytics querying and event tracking are available in all Admin SDKs.

Setup

TypeScript

import { createAdminClient } from '@edgebase/admin';

const admin = createAdminClient('https://my-edgebase-server.com', {
  serviceKey: process.env.EDGEBASE_SERVICE_KEY,
});

Dart

import 'dart:io';
import 'package:edgebase_admin/edgebase_admin.dart';

final admin = AdminEdgeBase(
  'https://my-edgebase-server.com',
  serviceKey: Platform.environment['EDGEBASE_SERVICE_KEY']!,
);

Kotlin

import dev.edgebase.sdk.admin.AdminEdgeBase

val admin = AdminEdgeBase(
    "https://my-edgebase-server.com",
    serviceKey = System.getenv("EDGEBASE_SERVICE_KEY") ?: ""
)

Java

import dev.edgebase.sdk.admin.*;

AdminEdgeBase admin = EdgeBase.admin(
    "https://my-edgebase-server.com",
    System.getenv("EDGEBASE_SERVICE_KEY")
);

Scala

import dev.edgebase.sdk.scala.admin.AdminEdgeBase

val admin = AdminEdgeBase(
  "https://my-edgebase-server.com",
  sys.env("EDGEBASE_SERVICE_KEY")
)

Python

import os
from edgebase_admin import AdminClient

admin = AdminClient(
    "https://my-edgebase-server.com",
    service_key=os.environ["EDGEBASE_SERVICE_KEY"],
)

Go

import (
    "os"
    edgebase "github.com/edgebase/sdk-go"
)

admin := edgebase.NewAdminClient("https://my-edgebase-server.com", os.Getenv("EDGEBASE_SERVICE_KEY"))

PHP

use EdgeBase\Admin\AdminClient;

$admin = new AdminClient('https://my-edgebase-server.com', getenv('EDGEBASE_SERVICE_KEY'));

Rust

use edgebase_admin::EdgeBase;

let admin = EdgeBase::server(
    "https://my-edgebase-server.com",
    &std::env::var("EDGEBASE_SERVICE_KEY").unwrap(),
)?;

C#

using System;
using EdgeBase.Admin;

var admin = new AdminClient(
    "https://my-edgebase-server.com",
    Environment.GetEnvironmentVariable("EDGEBASE_SERVICE_KEY")!
);

Ruby

require "edgebase_admin"

admin = EdgebaseAdmin::AdminClient.new(
  "https://my-edgebase-server.com",
  service_key: ENV.fetch("EDGEBASE_SERVICE_KEY")
)

Elixir

alias EdgeBaseAdmin

admin =
  EdgeBaseAdmin.new("https://my-edgebase-server.com",
    service_key: System.fetch_env!("EDGEBASE_SERVICE_KEY")
  )

The same analytics surface is exposed across all Admin SDKs for overview, timeSeries, breakdown, topEndpoints, track, trackBatch, and queryEvents.

---

Part 1: Request Log Metrics

These methods query automatic API usage data — the same metrics shown in the Admin Dashboard.

Overview

Get a complete snapshot: time series, summary, breakdown by category, and top endpoints.

TypeScript

const data = await admin.analytics.overview({ range: '7d' });
console.log(data.summary.totalRequests);
console.log(data.breakdown[0]);

Dart

final data = await admin.analytics.overview({'range': '7d'});
print(data['summary']);
print(data['breakdown']);

Kotlin

val data = admin.analytics.overview(mapOf("range" to "7d"))
println(data["summary"])
println(data["breakdown"])

Java

var data = admin.analytics().overview(Map.of("range", "7d"));
System.out.println(data.get("summary"));
System.out.println(data.get("breakdown"));

Scala

val data = admin.analytics.overview(Map("range" -> "7d"))
println(data("summary"))
println(data("breakdown"))

Python

data = admin.analytics.overview(range="7d")
print(data["summary"])
print(data["breakdown"])

Go

import "context"

ctx := context.Background()
data, _ := admin.Analytics.Overview(ctx, map[string]string{"range": "7d"})
fmt.Println(data["summary"])
fmt.Println(data["breakdown"])

PHP

$data = $admin->analytics()->overview(['range' => '7d']);
var_dump($data['summary']);
var_dump($data['breakdown']);

Rust

use std::collections::HashMap;

let data = admin.analytics().overview(Some(HashMap::from([
    ("range".to_string(), "7d".to_string())
]))).await?;
println!("{:?}", data.get("summary"));
println!("{:?}", data.get("breakdown"));

C#

var data = await admin.Analytics.OverviewAsync(new Dictionary<string, string> {
    ["range"] = "7d",
});
Console.WriteLine(data["summary"]);
Console.WriteLine(data["breakdown"]);

Ruby

data = admin.analytics.overview("range" => "7d")
pp data["summary"]
pp data["breakdown"]

Elixir

data =
  admin
  |> EdgeBaseAdmin.analytics()
  |> EdgeBaseAdmin.Analytics.overview!(range: "7d")

IO.inspect(data["summary"])
IO.inspect(data["breakdown"])

Time Series, Breakdown, and Top Endpoints

All request-log helpers accept the same option shape:

Parameter	Type	Default	Description
range	string	'24h'	Time range: '1h', '6h', '24h', '7d', '30d', '90d'
category	string	—	Filter by API category: 'auth', 'db', 'storage', 'realtime', 'push', 'functions'
groupBy	string	'hour'	Time grouping: 'minute', 'hour', 'day'

const points = await admin.analytics.timeSeries({ range: '24h', groupBy: 'hour' });
const items = await admin.analytics.breakdown({ range: '30d' });
const top = await admin.analytics.topEndpoints({ range: '7d' });

---

Part 2: Custom Events

Track and query custom events from your server-side code. Events are stored in LogsDO with 90-day retention (daily rollups for older data).

Tracking Events

TypeScript

await admin.analytics.track('user_upgraded', { plan: 'pro', amount: 29.99 }, 'user_123');

await admin.analytics.trackBatch([
  { name: 'email_sent', properties: { template: 'welcome' }, userId: 'user_123' },
  { name: 'cron_completed', properties: { job: 'cleanup', duration: 1200 } },
]);

Dart

await admin.analytics.track('user_upgraded', {'plan': 'pro', 'amount': 29.99}, 'user_123');

await admin.analytics.trackBatch([
  AnalyticsEvent(name: 'email_sent', properties: {'template': 'welcome'}, userId: 'user_123'),
  AnalyticsEvent(name: 'cron_completed', properties: {'job': 'cleanup', 'duration': 1200}),
]);

Kotlin

admin.analytics.track("user_upgraded", mapOf("plan" to "pro", "amount" to 29.99), "user_123")

admin.analytics.trackBatch(listOf(
    AnalyticsEvent(name = "email_sent", properties = mapOf("template" to "welcome"), userId = "user_123"),
    AnalyticsEvent(name = "cron_completed", properties = mapOf("job" to "cleanup", "duration" to 1200)),
))

Java

admin.analytics().track("user_upgraded", Map.of("plan", "pro", "amount", 29.99), "user_123");

admin.analytics().trackBatch(List.of(
    new AnalyticsClient.AnalyticsEvent("email_sent", Map.of("template", "welcome"), null, "user_123"),
    new AnalyticsClient.AnalyticsEvent("cron_completed", Map.of("job", "cleanup", "duration", 1200), null, null)
));

Scala

import dev.edgebase.sdk.scala.admin.AnalyticsEvent

admin.analytics.track(
  "user_upgraded",
  Map("plan" -> "pro", "amount" -> 29.99),
  userId = Some("user_123")
)

admin.analytics.trackBatch(Seq(
  AnalyticsEvent("email_sent", Map("template" -> "welcome"), userId = Some("user_123")),
  AnalyticsEvent("cron_completed", Map("job" -> "cleanup", "duration" -> 1200))
))

Python

admin.analytics.track("user_upgraded", {"plan": "pro", "amount": 29.99}, user_id="user_123")

admin.analytics.track_batch([
    {"name": "email_sent", "properties": {"template": "welcome"}, "userId": "user_123"},
    {"name": "cron_completed", "properties": {"job": "cleanup", "duration": 1200}},
])

Go

import "context"

ctx := context.Background()
_ = admin.Analytics.Track(ctx, "user_upgraded", map[string]interface{}{
    "plan": "pro",
    "amount": 29.99,
}, "user_123")

_ = admin.Analytics.TrackBatch(ctx, []edgebase.AnalyticsEvent{
    {Name: "email_sent", Properties: map[string]interface{}{"template": "welcome"}, UserID: "user_123"},
    {Name: "cron_completed", Properties: map[string]interface{}{"job": "cleanup", "duration": 1200}},
})

PHP

$admin->analytics()->track('user_upgraded', ['plan' => 'pro', 'amount' => 29.99], 'user_123');

$admin->analytics()->trackBatch([
    ['name' => 'email_sent', 'properties' => ['template' => 'welcome'], 'userId' => 'user_123'],
    ['name' => 'cron_completed', 'properties' => ['job' => 'cleanup', 'duration' => 1200]],
]);

Rust

use serde_json::json;

admin.analytics().track(
    "user_upgraded",
    Some(json!({"plan": "pro", "amount": 29.99})),
    Some("user_123"),
).await?;

admin.analytics().track_batch(vec![
    json!({"name": "email_sent", "properties": {"template": "welcome"}, "userId": "user_123"}),
    json!({"name": "cron_completed", "properties": {"job": "cleanup", "duration": 1200}}),
]).await?;

C#

await admin.Analytics.TrackAsync(
    "user_upgraded",
    new Dictionary<string, object?> { ["plan"] = "pro", ["amount"] = 29.99 },
    "user_123"
);

await admin.Analytics.TrackBatchAsync(new[] {
    new AnalyticsEvent { Name = "email_sent", Properties = new() { ["template"] = "welcome" }, UserId = "user_123" },
    new AnalyticsEvent { Name = "cron_completed", Properties = new() { ["job"] = "cleanup", ["duration"] = 1200 } },
});

Ruby

admin.analytics.track("user_upgraded", { "plan" => "pro", "amount" => 29.99 }, user_id: "user_123")

admin.analytics.track_batch([
  { "name" => "email_sent", "properties" => { "template" => "welcome" }, "userId" => "user_123" },
  { "name" => "cron_completed", "properties" => { "job" => "cleanup", "duration" => 1200 } }
])

Elixir

analytics = EdgeBaseAdmin.analytics(admin)

EdgeBaseAdmin.Analytics.track!(analytics, "user_upgraded", %{"plan" => "pro", "amount" => 29.99}, "user_123")

EdgeBaseAdmin.Analytics.track_batch!(analytics, [
  %{"name" => "email_sent", "properties" => %{"template" => "welcome"}, "userId" => "user_123"},
  %{"name" => "cron_completed", "properties" => %{"job" => "cleanup", "duration" => 1200}}
])

Track Parameters

Parameter	Type	Required	Description
name	string	Yes	Event name (e.g., 'purchase', 'signup')
properties	object	No	Key-value data (max 50 keys, 4 KB)
userId	string	No	Associate with a specific user

Querying Events

List Events

TypeScript

const result = await admin.analytics.queryEvents({
  metric: 'list',
  event: 'purchase',
  range: '7d',
  limit: 20,
});

console.log(result.events);

Dart

final result = await admin.analytics.queryEvents({
  'metric': 'list',
  'event': 'purchase',
  'range': '7d',
  'limit': '20',
});

print(result['events']);

Kotlin

val result = admin.analytics.queryEvents(
    mapOf("metric" to "list", "event" to "purchase", "range" to "7d", "limit" to "20")
)
println(result)

Java

Object result = admin.analytics().queryEvents(Map.of(
    "metric", "list",
    "event", "purchase",
    "range", "7d",
    "limit", "20"
));
System.out.println(result);

Scala

val result = admin.analytics.queryEvents(
  Map("metric" -> "list", "event" -> "purchase", "range" -> "7d", "limit" -> "20")
)
println(result)

Python

result = admin.analytics.query_events(metric="list", event="purchase", range="7d", limit="20")
print(result["events"])

Go

import "context"

ctx := context.Background()
result, _ := admin.Analytics.QueryEvents(ctx, map[string]string{
    "metric": "list",
    "event": "purchase",
    "range": "7d",
    "limit": "20",
})
fmt.Println(result["events"])

PHP

$result = $admin->analytics()->queryEvents([
    'metric' => 'list',
    'event' => 'purchase',
    'range' => '7d',
    'limit' => '20',
]);

var_dump($result['events']);

Rust

use std::collections::HashMap;

let result = admin.analytics().query_events(Some(HashMap::from([
    ("metric".to_string(), "list".to_string()),
    ("event".to_string(), "purchase".to_string()),
    ("range".to_string(), "7d".to_string()),
    ("limit".to_string(), "20".to_string()),
]))).await?;

println!("{:?}", result.get("events"));

C#

var result = await admin.Analytics.QueryEventsAsync(new Dictionary<string, string> {
    ["metric"] = "list",
    ["event"] = "purchase",
    ["range"] = "7d",
    ["limit"] = "20",
});

Console.WriteLine(result["events"]);

Ruby

result = admin.analytics.query_events(
  "metric" => "list",
  "event" => "purchase",
  "range" => "7d",
  "limit" => "20"
)

pp result["events"]

Elixir

result =
  admin
  |> EdgeBaseAdmin.analytics()
  |> EdgeBaseAdmin.Analytics.query_events!(
    metric: "list",
    event: "purchase",
    range: "7d",
    limit: "20"
  )

IO.inspect(result["events"])

Query Options

Parameter	Type	Default	Description
metric	string	'list'	'list', 'count', 'timeSeries', 'topEvents'
range	string	'24h'	Time range: '1h', '6h', '24h', '7d', '30d', '90d'
event	string	—	Filter by event name
userId	string	—	Filter by user ID
groupBy	string	'hour'	For timeSeries: 'minute', 'hour', 'day'
limit	number	50	Max events per page (for list)
cursor	string	—	Pagination cursor (from previous response)