API ReferenceProjects

Project usage summary

Markdown
GET
/api/v3/org/project/usage/summary

Aggregated metering usage for the authenticated project only. Requires ClickHouse logging (USE_CLICKHOUSE_FOR_LOGS). Values are summed from raw metering events grouped by entity_type.

Authorization

x-api-key<token>

Project API key authentication

In: header

Query Parameters

start_timestring

Inclusive range start (ISO 8601). Defaults to 30 days before end_time.

end_timestring

Exclusive range end (ISO 8601). Defaults to now.

entity_typesnullable array

Filter to these metering entity types (comma-separated or repeated query keys). Omit for all types.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/org/project/usage/summary"
{
  "rows": [
    {
      "entity_type": "string",
      "unit": "string",
      "total_quantity": "string",
      "event_count": 0
    }
  ]
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}