Usage
v1
Get Endpoints Usage
Access usage statistics for various API endpoints for monitoring and auditing purposes. Returns usage data for all endpoints accessible by the requesting account within the specified date range.
:::info Requires the usage:read OAuth2 scope. :::
get/v1/usage
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
start_periodstring required
The starting month for the usage period, formatted as YYYY-MM
end_periodstring required
The ending month for the usage period, formatted as YYYY-MM. Must be greater than or equal to start_period.
Response
Success
Example response
{
"data": [
{
"type": "api_usage",
"id": "2025-01_ip/enrich",
"attributes": {
"period": "2025-01",
"endpoint_path": "/ip/enrich",
"num_requests": 10,
"num_failed_requests": 2,
"num_successful_requests": 5,
"num_returned_entities": 100,
"last_accessed_at": "2025-01-15T14:30:00Z",
"http_method": "POST"
}
}
],
"meta": {
"total_records": 100,
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}