Skip to main content
GET
/
v1
/
analytics
/
knowledge
/
documents
/
cleanup-summary
Failure-recovery analytics: failed / archived / cleaned_up / recovered
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/knowledge/documents/cleanup-summary \
  --header 'x-api-key: <api-key>'
[
  {
    "time_bucket": "2023-11-07T05:31:56Z",
    "failed": 123,
    "archived": 123,
    "cleaned_up": 123,
    "recovered": 123,
    "net_unrecovered_failures": 123,
    "cleanup_rate_pct": 123
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
granularity
string
default:hour
Pattern: ^(minute|hour|day|week)$
​
knowledge_base_id
string | null
​
start_date
string<date>
required
​
end_date
string<date>
required

Response

Successful Response

​
time_bucket
string<date-time>
required
​
failed
integer
required
​
archived
integer
required
​
cleaned_up
integer
required
​
recovered
integer
required
​
net_unrecovered_failures
integer
required
​
cleanup_rate_pct
number
required