Skip to main content
GET
/
api
/
v1
/
usage
/
summary
Get overall usage summary
curl --request GET \
  --url https://neo.api.projectdiscovery.io/api/v1/usage/summary \
  --header 'Authorization: Bearer <token>'
{
  "by_model": {},
  "by_status": {},
  "total_neo_credits": 123,
  "total_tasks": 123,
  "by_email": [
    {
      "email": "<string>",
      "neo_credits": 123,
      "tasks": 123
    }
  ],
  "by_period": [
    {
      "date": "<string>",
      "neo_credits": 123,
      "tasks": 123
    }
  ],
  "byok": {
    "total_llm_cost": 123,
    "total_neo_cost": 123,
    "total_streams": 123,
    "total_tasks": 123
  },
  "last_credit_reset": "2023-11-07T05:31:56Z",
  "neo_credits_expires_at": "2023-11-07T05:31:56Z",
  "neo_credits_is_expired": true,
  "total_agent_triggers": 123,
  "total_available_neo_credits": 123,
  "total_execution_ms": 123,
  "total_issued_neo_credits": 123,
  "total_neo_credits_post_reset": 123,
  "total_steps": 123,
  "total_tool_calls": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.neo.projectdiscovery.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

JWT authentication token

Query Parameters

from
string<date-time>

Filter from datetime (ISO 8601)

to
string<date-time>

Filter to datetime (ISO 8601)

group_by
enum<string>

Group by time period

Available options:
day,
week,
month

Response

Usage summary

by_model
object
required

Usage statistics by model

by_status
object
required

Task counts by status

total_neo_credits
number<float>
required

Total Neo credits used

total_tasks
integer
required

Total number of tasks

by_email
object[]

Usage statistics by team member email, sorted by neo_credits descending (only for team admins)

by_period
object[]

Usage statistics by time period (only if group_by is specified)

byok
object

BYOK (Bring Your Own Key) usage breakdown

last_credit_reset
string<date-time> | null

When set, the datetime from which credit usage is counted. Usage before this date is excluded from used/available credit calculations.

neo_credits_expires_at
string<date-time> | null

When set, credits will be frozen (available=0) after this date. NULL means never expires.

neo_credits_is_expired
boolean

Whether the Neo credits have expired (expires_at is in the past)

total_agent_triggers
integer

Total agent triggers

total_available_neo_credits
number<float>

Available Neo credits since last reset (issued - used since reset). Not affected by date filters. Returns 0 if credits are expired.

total_execution_ms
integer

Total execution time in milliseconds

total_issued_neo_credits
number<float>

Total Neo credits issued/allocated to the user

total_neo_credits_post_reset
number<float>

Neo credits used since the last reset (issued - available). Not affected by date filters.

total_steps
integer

Total steps executed

total_tool_calls
integer

Total tool calls