Metrics

Get Summary Metrics

Retrieve summary metrics for an account, with optional filtering capabilities.

Path Parameters

string

required

Account identifier (format: acc_ followed by 27 alphanumeric characters)

Query Parameters

string

Filter metrics by specific bucket

string

Start date for metrics (ISO 8601 format)

string

End date for metrics (ISO 8601 format)

string

Filter by environment identifier

Headers

string

required

Bearer token for authentication

Response

number

Total number of requests in the time period

number

Total number of error responses (4xx/5xx status codes)

number

Average response time in milliseconds

number

Total bytes transferred (request + response)

object

Breakdown of requests by HTTP method

object

Breakdown of requests by HTTP status code ranges

array

Most frequently accessed endpoints

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/summary?startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/summary?startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const metrics = await response.json();
console.log(metrics);

import requests

response = requests.get(
    'https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/summary',
    params={
        'startDate': '2023-12-01T00:00:00Z',
        'endDate': '2023-12-02T00:00:00Z'
    },
    headers={'Authorization': 'Bearer your-jwt-token'}
)

metrics = response.json()
print(metrics)

{
  "totalRequests": 15420,
  "totalErrors": 234,
  "averageResponseTime": 145.6,
  "totalDataTransferred": 2048576,
  "requestsByMethod": {
    "GET": 12340,
    "POST": 2100,
    "PUT": 680,
    "DELETE": 300
  },
  "requestsByStatus": {
    "2xx": 14186,
    "3xx": 1000,
    "4xx": 200,
    "5xx": 34
  },
  "topEndpoints": [
    {
      "path": "/api/users",
      "count": 3420,
      "averageResponseTime": 120.5
    },
    {
      "path": "/api/orders",
      "count": 2100,
      "averageResponseTime": 180.2
    }
  ]
}

Get Throughput Metrics

Retrieve request throughput metrics over time.

Path Parameters

string

required

Account identifier

Query Parameters

string

Filter metrics by specific bucket

string

Start date for metrics (ISO 8601 format)

string

End date for metrics (ISO 8601 format)

string

Time interval for grouping: hour, day, week, month

Headers

string

required

Bearer token for authentication

Response

string

Time interval used for grouping

array

Show Throughput Data Points

string

ISO 8601 timestamp for the data point

number

Number of requests in this time interval

number

Number of errors in this time interval

number

Average response time for this interval

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/throughput?interval=hour&startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/throughput?interval=hour&startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const throughput = await response.json();
console.log(throughput);

{
  "interval": "hour",
  "data": [
    {
      "timestamp": "2023-12-01T00:00:00Z",
      "requestCount": 450,
      "errorCount": 12,
      "averageResponseTime": 142.3
    },
    {
      "timestamp": "2023-12-01T01:00:00Z",
      "requestCount": 523,
      "errorCount": 8,
      "averageResponseTime": 138.7
    }
  ]
}

Get Performance Metrics

Retrieve detailed performance metrics including response times, error rates, and endpoint analytics.

Path Parameters

string

required

Account identifier

Query Parameters

string

Filter metrics by specific bucket

string

Start date for metrics (ISO 8601 format)

string

End date for metrics (ISO 8601 format)

string

Group metrics by: endpoint, method, status, environment

Headers

string

required

Bearer token for authentication

Response

string

The grouping method used

array

Show Performance Metrics

string

The group identifier (endpoint, method, etc.)

number

Total requests for this group

number

Error rate as a percentage (0-100)

number

Average response time in milliseconds

number

50th percentile response time

number

95th percentile response time

number

99th percentile response time

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/performance?groupBy=endpoint&startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/performance?groupBy=endpoint&startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const performance = await response.json();
console.log(performance);

{
  "groupBy": "endpoint",
  "metrics": [
    {
      "group": "/api/users",
      "requestCount": 3420,
      "errorRate": 1.2,
      "averageResponseTime": 120.5,
      "p50ResponseTime": 95.0,
      "p95ResponseTime": 280.0,
      "p99ResponseTime": 450.0
    },
    {
      "group": "/api/orders",
      "requestCount": 2100,
      "errorRate": 2.8,
      "averageResponseTime": 180.2,
      "p50ResponseTime": 145.0,
      "p95ResponseTime": 420.0,
      "p99ResponseTime": 650.0
    }
  ]
}

Get Error Metrics

Retrieve detailed error analysis and patterns.

Path Parameters

string

required

Account identifier

Query Parameters

string

Filter metrics by specific bucket

string

Start date for metrics (ISO 8601 format)

string

End date for metrics (ISO 8601 format)

number

Filter by specific HTTP status code

Headers

string

required

Bearer token for authentication

Response

number

Total number of errors in the time period

number

Overall error rate as a percentage

object

Breakdown of errors by HTTP status code

array

Show Endpoint Error Analysis

string

API endpoint path

number

Number of errors for this endpoint

number

Error rate percentage for this endpoint

array

Most frequent error status codes

curl -X GET "https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/errors?startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z" \
  -H "Authorization: Bearer your-jwt-token"

const response = await fetch('https://api.apitraffic.io/v1/accounts/acc_abc123def456ghi789jkl012/metrics/errors?startDate=2023-12-01T00:00:00Z&endDate=2023-12-02T00:00:00Z', {
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const errors = await response.json();
console.log(errors);

{
  "totalErrors": 234,
  "errorRate": 1.52,
  "errorsByStatus": {
    "400": 120,
    "401": 45,
    "404": 35,
    "500": 25,
    "503": 9
  },
  "errorsByEndpoint": [
    {
      "endpoint": "/api/auth/login",
      "errorCount": 45,
      "errorRate": 3.2,
      "mostCommonErrors": [401, 400]
    },
    {
      "endpoint": "/api/users/profile",
      "errorCount": 35,
      "errorRate": 2.1,
      "mostCommonErrors": [404, 403]
    }
  ]
}

API Documentation

Core Resources

Data Management

Automation

Get Summary Metrics

Path Parameters

Query Parameters

Headers

Response

Get Throughput Metrics

Path Parameters

Query Parameters

Headers

Response

Get Performance Metrics

Path Parameters

Query Parameters

Headers

Response

Get Error Metrics

Path Parameters

Query Parameters

Headers

Response

​Get Summary Metrics

​Path Parameters

​Query Parameters

​Headers

​Response

​Get Throughput Metrics

​Path Parameters

​Query Parameters

​Headers

​Response

​Get Performance Metrics

​Path Parameters

​Query Parameters

​Headers

​Response

​Get Error Metrics

​Path Parameters

​Query Parameters

​Headers

​Response

Get Summary Metrics

Path Parameters

Query Parameters

Headers

Response

Get Throughput Metrics

Path Parameters

Query Parameters

Headers

Response

Get Performance Metrics

Path Parameters

Query Parameters

Headers

Response

Get Error Metrics

Path Parameters

Query Parameters

Headers

Response