Usage

Returns usage statistics for the authenticated organization, broken down by endpoint.

string

The endpoint path (e.g., entire/detect, v1/detect).

integer

Total number of data points processed through this endpoint.

integer

Total number of API calls to this endpoint.

curl https://api.canaryedge.com/v1/usage \
  -H "X-Canary-Key: YOUR_API_KEY"

[
  {
    "endpoint": "entire/detect",
    "total_points": 3450000,
    "call_count": 847
  },
  {
    "endpoint": "last/detect",
    "total_points": 500000,
    "call_count": 1250
  },
  {
    "endpoint": "v1/detect",
    "total_points": 1200000,
    "call_count": 312
  }
]

curl https://api.canaryedge.com/v1/usage \
  -H "X-Canary-Key: YOUR_API_KEY"

[
  {
    "endpoint": "entire/detect",
    "total_points": 3450000,
    "call_count": 847
  },
  {
    "endpoint": "last/detect",
    "total_points": 500000,
    "call_count": 1250
  },
  {
    "endpoint": "v1/detect",
    "total_points": 1200000,
    "call_count": 312
  }
]

Getting Started

Guides

API Reference

Azure-Compatible Endpoints

Native Endpoints

System