Appearance

Analytics ​

Access usage analytics, cost tracking, and performance metrics.

Usage Overview ​

Endpoint ​

GET /v1/management/analytics/usage

Query Parameters ​

ParameterTypeDescription
start_datestringStart date (YYYY-MM-DD)
end_datestringEnd date (YYYY-MM-DD)
granularitystringhour, day, week, month
group_bystringmodel, provider, api_key

Example ​

bash
curl "https://api.gateflow.ai/v1/management/analytics/usage?start_date=2026-02-01&end_date=2026-02-16&granularity=day" \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "period": {
    "start": "2026-02-01",
    "end": "2026-02-16"
  },
  "totals": {
    "requests": 125000,
    "tokens": {
      "prompt": 45000000,
      "completion": 12000000,
      "total": 57000000
    },
    "cost_usd": 570.00,
    "latency_ms": {
      "p50": 450,
      "p95": 1200,
      "p99": 2500
    }
  },
  "data": [
    {
      "date": "2026-02-01",
      "requests": 8000,
      "tokens": 3500000,
      "cost_usd": 35.00
    },
    {
      "date": "2026-02-02",
      "requests": 7500,
      "tokens": 3200000,
      "cost_usd": 32.00
    }
  ]
}

Usage by Model ​

Endpoint ​

GET /v1/management/analytics/usage/models

Example ​

bash
curl "https://api.gateflow.ai/v1/management/analytics/usage/models?start_date=2026-02-01&end_date=2026-02-16" \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "period": {
    "start": "2026-02-01",
    "end": "2026-02-16"
  },
  "models": [
    {
      "model": "gpt-5.2",
      "provider": "openai",
      "requests": 50000,
      "tokens": {
        "prompt": 20000000,
        "completion": 5000000
      },
      "cost_usd": 250.00,
      "avg_latency_ms": 480
    },
    {
      "model": "claude-sonnet-4-5-20250929",
      "provider": "anthropic",
      "requests": 30000,
      "tokens": {
        "prompt": 15000000,
        "completion": 4000000
      },
      "cost_usd": 180.00,
      "avg_latency_ms": 420
    },
    {
      "model": "gpt-5-mini",
      "provider": "openai",
      "requests": 45000,
      "tokens": {
        "prompt": 10000000,
        "completion": 3000000
      },
      "cost_usd": 65.00,
      "avg_latency_ms": 350
    }
  ]
}

Usage by API Key ​

Endpoint ​

GET /v1/management/analytics/usage/api-keys

Example ​

bash
curl "https://api.gateflow.ai/v1/management/analytics/usage/api-keys?start_date=2026-02-01&end_date=2026-02-16" \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "api_keys": [
    {
      "key_id": "key_abc123",
      "name": "production-backend",
      "requests": 80000,
      "tokens": 40000000,
      "cost_usd": 400.00,
      "rate_limit_hits": 12
    },
    {
      "key_id": "key_def456",
      "name": "mobile-app",
      "requests": 45000,
      "tokens": 17000000,
      "cost_usd": 170.00,
      "rate_limit_hits": 3
    }
  ]
}

Cost Analytics ​

Endpoint ​

GET /v1/management/analytics/costs

Example ​

bash
curl "https://api.gateflow.ai/v1/management/analytics/costs?start_date=2026-02-01&end_date=2026-02-16&granularity=day" \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "period": {
    "start": "2026-02-01",
    "end": "2026-02-16"
  },
  "totals": {
    "cost_usd": 570.00,
    "cache_savings_usd": 85.00,
    "effective_cost_usd": 485.00
  },
  "by_provider": {
    "openai": 315.00,
    "anthropic": 180.00,
    "google": 45.00,
    "elevenlabs": 30.00
  },
  "by_category": {
    "chat": 450.00,
    "embeddings": 50.00,
    "audio": 70.00
  },
  "data": [
    {
      "date": "2026-02-01",
      "cost_usd": 35.00,
      "cache_savings_usd": 5.00
    }
  ]
}

Performance Analytics ​

Endpoint ​

GET /v1/management/analytics/performance

Example ​

bash
curl "https://api.gateflow.ai/v1/management/analytics/performance?start_date=2026-02-01&end_date=2026-02-16" \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "period": {
    "start": "2026-02-01",
    "end": "2026-02-16"
  },
  "latency": {
    "p50_ms": 450,
    "p95_ms": 1200,
    "p99_ms": 2500,
    "avg_ms": 520
  },
  "throughput": {
    "requests_per_minute": 85,
    "tokens_per_minute": 35000
  },
  "reliability": {
    "success_rate": 0.9985,
    "error_rate": 0.0015,
    "timeout_rate": 0.0005
  },
  "by_provider": {
    "openai": {
      "latency_p50_ms": 480,
      "success_rate": 0.998
    },
    "anthropic": {
      "latency_p50_ms": 420,
      "success_rate": 0.999
    }
  }
}

Error Analytics ​

Endpoint ​

GET /v1/management/analytics/errors

Example ​

bash
curl "https://api.gateflow.ai/v1/management/analytics/errors?start_date=2026-02-01&end_date=2026-02-16" \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "period": {
    "start": "2026-02-01",
    "end": "2026-02-16"
  },
  "total_errors": 188,
  "error_rate": 0.0015,
  "by_type": {
    "rate_limit": 95,
    "timeout": 45,
    "provider_error": 30,
    "invalid_request": 18
  },
  "by_provider": {
    "openai": 80,
    "anthropic": 25,
    "google": 40
  },
  "by_model": {
    "gpt-5.2": 50,
    "claude-sonnet-4-5-20250929": 20,
    "gemini-3-pro": 35
  }
}

Cache Analytics ​

Endpoint ​

GET /v1/management/analytics/cache

Example ​

bash
curl "https://api.gateflow.ai/v1/management/analytics/cache?start_date=2026-02-01&end_date=2026-02-16" \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "period": {
    "start": "2026-02-01",
    "end": "2026-02-16"
  },
  "totals": {
    "cache_hits": 15000,
    "cache_misses": 110000,
    "hit_rate": 0.12,
    "tokens_saved": 8000000,
    "cost_saved_usd": 85.00
  },
  "by_model": {
    "gpt-5.2": {
      "hits": 8000,
      "hit_rate": 0.16,
      "cost_saved_usd": 50.00
    },
    "gpt-5-mini": {
      "hits": 7000,
      "hit_rate": 0.15,
      "cost_saved_usd": 35.00
    }
  }
}

Export Analytics ​

Endpoint ​

POST /v1/management/analytics/export

Request Body ​

ParameterTypeDescription
start_datestringStart date
end_datestringEnd date
formatstringcsv, json, parquet
includearrayData to include

Example ​

bash
curl -X POST https://api.gateflow.ai/v1/management/analytics/export \
  -H "Authorization: Bearer gw_admin_..." \
  -H "Content-Type: application/json" \
  -d '{
    "start_date": "2026-02-01",
    "end_date": "2026-02-16",
    "format": "csv",
    "include": ["usage", "costs", "errors"]
  }'

Response ​

json
{
  "export_id": "export_abc123",
  "status": "processing",
  "download_url": null,
  "expires_at": null
}

Check Export Status ​

bash
curl https://api.gateflow.ai/v1/management/analytics/export/export_abc123 \
  -H "Authorization: Bearer gw_admin_..."

Response (Complete) ​

json
{
  "export_id": "export_abc123",
  "status": "complete",
  "download_url": "https://api.gateflow.ai/v1/management/analytics/export/export_abc123/download",
  "expires_at": "2026-02-17T10:00:00Z"
}

Real-Time Metrics ​

Endpoint ​

GET /v1/management/analytics/realtime

Example ​

bash
curl https://api.gateflow.ai/v1/management/analytics/realtime \
  -H "Authorization: Bearer gw_admin_..."

Response ​

json
{
  "timestamp": "2026-02-16T10:30:00Z",
  "last_minute": {
    "requests": 85,
    "tokens": 35000,
    "cost_usd": 0.35,
    "avg_latency_ms": 450
  },
  "active_requests": 12,
  "queue_depth": 5,
  "provider_status": {
    "openai": "healthy",
    "anthropic": "healthy",
    "google": "degraded"
  }
}

Errors ​

CodeDescription
400Invalid date range or parameters
401Invalid admin key
403Insufficient permissions
429Rate limit exceeded

See Also ​

Built with reliability in mind.

Copyright 2026 GateFlow