> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentgate.mynewapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Usage Summary

> Get aggregated usage summary with totals and per-model breakdown

# Get Usage Summary

Returns aggregated usage summary including totals and per-model breakdown.

## Request

<ParamField query="workOrderId" type="string">
  Filter by work order ID
</ParamField>

<ParamField query="runId" type="string">
  Filter by run ID
</ParamField>

<ParamField query="model" type="string">
  Filter by model name
</ParamField>

<ParamField query="startDate" type="string">
  Start date filter (ISO 8601)
</ParamField>

<ParamField query="endDate" type="string">
  End date filter (ISO 8601)
</ParamField>

```bash theme={null}
curl "https://agentgate.mynewapi.com/api/v1/usage/summary?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Response

<ResponseField name="success" type="boolean" required>
  Indicates if the request was successful
</ResponseField>

<ResponseField name="data" type="object" required>
  Usage summary data

  <Expandable title="properties">
    <ResponseField name="totalInputTokens" type="number" required>
      Total input tokens used
    </ResponseField>

    <ResponseField name="totalOutputTokens" type="number" required>
      Total output tokens used
    </ResponseField>

    <ResponseField name="totalCachedInputTokens" type="number" required>
      Total cached input tokens
    </ResponseField>

    <ResponseField name="totalCostUsd" type="number" required>
      Total estimated cost in USD
    </ResponseField>

    <ResponseField name="executionCount" type="number" required>
      Total number of executions
    </ResponseField>

    <ResponseField name="workOrderCount" type="number" required>
      Number of unique work orders
    </ResponseField>

    <ResponseField name="totalDurationMs" type="number" required>
      Total execution duration in milliseconds
    </ResponseField>

    <ResponseField name="byModel" type="object" required>
      Usage breakdown by model
    </ResponseField>

    <ResponseField name="periodStart" type="string" required>
      Period start date (ISO 8601)
    </ResponseField>

    <ResponseField name="periodEnd" type="string" required>
      Period end date (ISO 8601)
    </ResponseField>
  </Expandable>
</ResponseField>

## Example Response

```json theme={null}
{
  "success": true,
  "data": {
    "totalInputTokens": 1542000,
    "totalOutputTokens": 325000,
    "totalCachedInputTokens": 800000,
    "totalCostUsd": 52.34,
    "executionCount": 145,
    "workOrderCount": 42,
    "totalDurationMs": 4523000,
    "byModel": {
      "claude-sonnet-4-20250514": {
        "inputTokens": 1200000,
        "outputTokens": 250000,
        "cachedInputTokens": 650000,
        "costUsd": 38.50,
        "executionCount": 120
      },
      "claude-opus-4-20250514": {
        "inputTokens": 342000,
        "outputTokens": 75000,
        "cachedInputTokens": 150000,
        "costUsd": 13.84,
        "executionCount": 25
      }
    },
    "periodStart": "2024-01-01T00:00:00.000Z",
    "periodEnd": "2024-01-31T23:59:59.999Z"
  }
}
```

## Use Cases

* Generate monthly usage reports
* Compare costs across models
* Track usage trends over time
* Budget monitoring and alerts