LEleadfeeder
Usage
v1

Get Endpoints Usage

Changed on

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

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/usage
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.leadfeeder.com/v1/oauth/authorize
      Token URL: https://api.leadfeeder.com/v1/oauth/token scopes: usage:read

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": [
    {
      "attributes": {
        "endpoint_path": "/ip/enrich",
        "http_method": "POST",
        "last_accessed_at": "2025-01-15T14:30:00Z",
        "num_failed_requests": 2,
        "num_requests": 10,
        "num_returned_entities": 100,
        "num_successful_requests": 5,
        "period": "2025-01"
      },
      "id": "2025-01_ip/enrich",
      "type": "api_usage"
    }
  ],
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f",
    "total_records": 100
  }
}

Changes

  • ac752c6c2be0Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 12ae8a6b9fadRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      added the non-success response with the status