Skip to main content
GET
/
account
/
stats
Get Account Statistics
curl --request GET \
  --url https://{base_url}/account/stats \
  --header 'X-API-Key: <api-key>'
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "usage": {
    "jobs": {
      "summary": {
        "total": 123,
        "completed": 123,
        "failed": 123,
        "in_progress": 123,
        "in_queue": 123,
        "cancelled": 123,
        "success_rate": 123
      },
      "detail": [
        {
          "type": "PREDICT",
          "total": 123,
          "completed": 123,
          "failed": 123,
          "in_progress": 123,
          "in_queue": 123,
          "cancelled": 123
        }
      ]
    },
    "files": {
      "summary": {
        "total": 123,
        "total_pages": 123,
        "total_size_mb": 123
      },
      "detail": [
        {
          "type": "<string>",
          "total": 123,
          "total_pages": 123,
          "total_size_mb": 123
        }
      ]
    }
  },
  "generated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

date_from
string<date>

Start date for filtering statistics (YYYY-MM-DD format)

date_to
string<date>

End date for filtering statistics (YYYY-MM-DD format)

Response

Account usage statistics

user_id
string<uuid>

UUID of the authenticated user

usage
object
generated_at
string<date-time>

Timestamp when statistics were generated