collectCcusage

Mutation

mutation CollectCcusage {
  collectCcusage {
    id
    status
    createdAt
    deadlineAt
    finishedAt
    progress {
      eligibleCount
      finishedCount
      successfulCount
      agents {
        agent {
          __typename
        }
        status
        jobId
        error
      }
    }
  }
}

Response

{
  "data": {
    "collectCcusage": {
      "id": "id",
      "status": "COLLECTING",
      "createdAt": "string",
      "deadlineAt": "string",
      "finishedAt": "string",
      "progress": {
        "eligibleCount": 1,
        "finishedCount": 1,
        "successfulCount": 1,
        "agents": [
          {
            "agent": {
              "__typename": "Agent"
            },
            "status": "QUEUING",
            "jobId": "id",
            "error": "string"
          }
        ]
      }
    }
  }
}

MUTATION

collectCcusage(requestId: ID): CcusageCollection!

Arguments

requestId

Identifier of the request.

Returns

CcusageCollection!

ID!

Stable identifier for this Claude Code usage collection.

status

CcusageCollectionStatus!

Current status of this Claude Code usage collection.

createdAt

String!

ISO 8601 timestamp when this Claude Code usage collection was created.

deadlineAt

String!

ISO 8601 timestamp when this Claude Code usage collection deadline.

finishedAt

String

ISO 8601 timestamp when this Claude Code usage collection finished. May be null when unavailable or not applicable.

progress

CcusageProgress!

The progress associated with this Claude Code usage collection.

hasStoredHistory

Boolean!

Whether durable Claude Code usage history is stored.

aggregate

CcusageAggregate!

The aggregate associated with this Claude Code usage collection.

Arguments

range

CcusageRange

default:ALL

The range used to filter or perform the operation. Defaults to ALL.

includeHistory

Boolean

default:true

Whether stored usage history is included. Defaults to true.

Mutation

mutation CollectCcusage {
  collectCcusage {
    id
    status
    createdAt
    deadlineAt
    finishedAt
    progress {
      eligibleCount
      finishedCount
      successfulCount
      agents {
        agent {
          __typename
        }
        status
        jobId
        error
      }
    }
  }
}

Response

{
  "data": {
    "collectCcusage": {
      "id": "id",
      "status": "COLLECTING",
      "createdAt": "string",
      "deadlineAt": "string",
      "finishedAt": "string",
      "progress": {
        "eligibleCount": 1,
        "finishedCount": 1,
        "successfulCount": 1,
        "agents": [
          {
            "agent": {
              "__typename": "Agent"
            },
            "status": "QUEUING",
            "jobId": "id",
            "error": "string"
          }
        ]
      }
    }
  }
}

Overview

Queries

Mutations

Types

Arguments

Returns