Get User Document Count Data
GET
/api/v2/analytics/users/document-counts
include_types (bool): Whether to include document type breakdown (default: true)
type (str): Query type ('fixed' or 'range')
days (int): Number of days to look back (for 'fixed' type)
start_date (str): Start date in ISO format (for 'range' type)
end_date (str): End date in ISO format (for 'range' type)
time_series (bool): Whether to return data in time series format
bucket_type (str): Type of time bucket ('day', 'week', 'month')
limit (int): Number of top entities to return per date bucket (default: 10)
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https:///api/v2/analytics/users/document-counts?bucket_type=day&days=30&end_date=2024-03-31&include_types=true&limit=10&start_date=2024-03-01&time_series=true&type=fixed&user_id' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Response without document types
{
"success": true,
"message": "User document data retrieved successfully",
"data": {
"document_counts": [
{
"user_name": "Example User",
"total_documents": 100
}
]
}
}