Skip to main content
Access usage statistics and performance metrics for your tenant’s API usage.

​
Get Usage Statistics

​
month
string
Month in YYYY-MM format (e.g., “2024-01”). Defaults to current month.
​
success
boolean
true
​
data.month
string
Month in YYYY-MM format
​
data.usage.totalRequests
number
Total API requests in the month
​
data.usage.requestsByEndpoint
object
Requests broken down by endpoint path
​
data.usage.requestsByMethod
object
Requests broken down by HTTP method (GET, POST, etc.)
​
data.limits.apiCalls
number
Monthly API call limit from your plan (-1 for unlimited)
​
data.limits.isUnlimited
boolean
Whether the plan has unlimited API calls
​
data.overage.requests
number
Number of requests exceeding the plan limit
​
data.overage.percentage
number
Percentage of limit exceeded

​
Example Request

curl -X GET "https://api.g-tateth.com/api/v1/analytics/usage?month=2024-01" \
  -H "Authorization: Bearer sk_live_your_api_key"

​
Example Response

{
  "success": true,
  "data": {
    "month": "2024-01",
    "usage": {
      "totalRequests": 12500,
      "requestsByEndpoint": {
        "/api/v1/conversations": 8500,
        "/api/v1/customers": 3000,
        "/api/v1/webhooks": 1000
      },
      "requestsByMethod": {
        "GET": 11000,
        "POST": 1000,
        "PUT": 400,
        "DELETE": 100
      }
    },
    "limits": {
      "apiCalls": 10000,
      "isUnlimited": false
    },
    "overage": {
      "requests": 2500,
      "percentage": 25
    }
  }
}

​
Get Usage History

​
months
integer
Number of months to retrieve (1-24, default: 12)
​
success
boolean
true
​
data
array
Array of usage objects, one per month

​
Example Request

curl -X GET "https://api.g-tateth.com/api/v1/analytics/usage/history?months=6" \
  -H "Authorization: Bearer sk_live_your_api_key"

​
Example Response

{
  "success": true,
  "data": [
    {
      "month": "2024-01",
      "totalRequests": 12500,
      "requestsByEndpoint": {
        "/api/v1/conversations": 8500,
        "/api/v1/customers": 3000,
        "/api/v1/webhooks": 1000
      }
    },
    {
      "month": "2023-12",
      "totalRequests": 9800,
      "requestsByEndpoint": {
        "/api/v1/conversations": 6500,
        "/api/v1/customers": 2500,
        "/api/v1/webhooks": 800
      }
    }
  ]
}

​
Get Performance Metrics

​
month
string
Month in YYYY-MM format (e.g., “2024-01”). Defaults to current month.
​
success
boolean
true
​
data.month
string
Month in YYYY-MM format
​
data.averageResponseTime
number
Average API response time in milliseconds
​
data.p95ResponseTime
number
95th percentile response time in milliseconds
​
data.p99ResponseTime
number
99th percentile response time in milliseconds
​
data.errorRate
number
Percentage of requests that resulted in errors
​
data.totalRequests
number
Total requests in the month
​
data.successfulRequests
number
Number of successful requests (2xx status codes)
​
data.failedRequests
number
Number of failed requests (4xx, 5xx status codes)

​
Example Request

curl -X GET "https://api.g-tateth.com/api/v1/analytics/metrics?month=2024-01" \
  -H "Authorization: Bearer sk_live_your_api_key"

​
Example Response

{
  "success": true,
  "data": {
    "month": "2024-01",
    "averageResponseTime": 125,
    "p95ResponseTime": 250,
    "p99ResponseTime": 500,
    "errorRate": 0.5,
    "totalRequests": 12500,
    "successfulRequests": 12437,
    "failedRequests": 63
  }
}

​
Required Permissions

  • read:analytics - Required for all analytics endpoints
Analytics data is aggregated monthly. Historical data is available for up to 24 months.