Get Endpoints Usage

GET

/v1/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.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.leadfeeder.com/v1/usage?account_id=123456&start_period=2025-01&end_period=2026-01' \
--header 'X-Api-Key: <api-key>'

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "data": [
        {
            "attributes": {
                "endpoint_path": "/companies/search",
                "http_method": "POST",
                "num_failed_requests": 1,
                "num_requests": 10,
                "num_returned_entities": 100,
                "num_successful_requests": 5,
                "period": "2025-01"
            },
            "id": "2025-01_companies/search_POST",
            "type": "api_usage"
        },
        {
            "attributes": {
                "endpoint_path": "/companies",
                "http_method": "GET",
                "num_failed_requests": 1,
                "num_requests": 25,
                "num_returned_entities": 48,
                "num_successful_requests": 24,
                "period": "2025-03"
            },
            "id": "2025-03_companies_GET",
            "type": "api_usage"
        }
    ],
    "meta": {
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f",
        "total_records": 2
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Server Error

🔴500Server Error

🔴504Gateway Timeout

Modified at 2026-10-13 07:27:21

Update Data Processing Settings

Get Countries with Regions