Skip to content
PalomPalomAtlas

Stats

GET
/api/v1/buckets/{bucket}/stats
curl --request GET \
  --url 'https://example.com/api/v1/buckets/example/stats?days=30'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
bucket
required
Bucket
string

Query Parameters

Section titled “Query Parameters”
days
Days
integer
default: 30 >= 1 <= 365

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
BucketStats
object
document_count
required
Document Count
integer
document_total_size
required
Document Total Size
integer
versioned_storage_total_size
required
Versioned Storage Total Size
integer
stored_object_count
required
Stored Object Count
integer
distinct_key_count
required
Distinct Key Count
integer
orphan_count
required
Orphan Count
integer
stale_count
required
Stale Count
integer
documents_by_state
required
Documents By State
Array<object>
DocumentStateCountModel
object
state
required
DocumentState
string
Allowed values: NORMAL PROCESSING SUCCESS ERROR
count
required
Count
integer
audit_event_count
required
Audit Event Count
integer
audit_events_by_action
required
Audit Events By Action
Array<object>
AuditActionCountModel
object
action
required
AuditAction
string
Allowed values: INDEX UPLOAD UNINDEX UPDATE DELETE RENAME MOVE LOCK UNLOCK SET_RETENTION DELETE_VERSION RESTORE_VERSION GRANT_ROLE UPDATE_ROLE REVOKE_ROLE
count
required
Count
integer
audit_activity
required
Audit Activity
Array<object>
AuditActivityPointModel
object
date
required
Date
string format: date
counts
required
Counts
object
key
additional properties
integer
Example
{
  "documents_by_state": [
    {
      "state": "NORMAL"
    }
  ],
  "audit_events_by_action": [
    {
      "action": "INDEX"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}