Overall Stats API
This endpoint can be used for retrieving dashboard statistics of given target domain.
The Overall Stats endpoint returns aggregate intelligence metrics for a target domain. It is the analytics counterpart to the leak-retrieval endpoints and is used to drive dashboards, executive reports, and posture monitoring rather than incident-level credential lookups.
A single request returns one named metric. To assemble a complete dashboard view, multiple calls are made in parallel — one per metric — using the same query value.
This endpoint supports thirteen metrics covering exposure counts, application breakdowns, incident timelines, recent activity, and country distribution.
Endpoint
POST https://api.whiteintel.io/get_overall_stats.phpHeaders
Content-Type
application/json
Authentication
Authentication is performed via an API key passed in the request body. Your API key can be retrieved from either the Organizations page or the Profile page on the Whiteintel platform.
{
"apikey": "YOUR_API_KEY"
}Requests without a valid API key return 403 Forbidden.
Access Requirements
This endpoint is available to Enterprise and Threat Intelligence subscription tiers. Lower tiers will receive a 403 Forbidden response with an upgrade message.
Quotas
Each API key is provisioned with a daily request quota. Remaining quota is returned in every successful response under remaining_daily_calls. Once the daily quota is exhausted, requests return a quota-exceeded message until the counter resets.
Each call consumes one daily quota credit, regardless of which metric is requested. Empty array results for list-style metrics (timelines, applications, recent events, country distribution) do not consume a credit. Empty count results for scalar metrics (consumer count, corporate count, etc.) do consume a credit because the response always contains zero-valued fields.
Request Parameters
apikey
string
Yes
—
Your Whiteintel API key.
query
string
Yes
—
The target domain or subdomain (e.g. acme.com). The endpoint will resolve the value to its registrable domain or full subdomain and use that as the lookup key.
metric
string
Yes
—
The metric to compute. See Available Metrics for the full list.
Notes on query
queryThe query field accepts both registrable domains and subdomains. Invalid query formats return a validation error. The resolved domain is echoed back in the response under the target_domain field so clients can confirm how the value was interpreted.
Available Metrics
consumer_count
object
Total credentials captured on the target domain's websites, broken down by source.
corporate_count
object
Total credentials whose username belongs to the target domain's email domain, broken down by source.
computer_count
object
Number of distinct infected machines that touched the target domain in any way.
ip_address_count
object
Number of unique IP addresses that touched the target domain in any way.
application_count
object
Number of distinct applications (subdomains) of the target domain that have been observed in leaks.
third_party_application_count
object
Number of distinct external applications that the target domain's users have logged into using corporate credentials.
applications
array
Top 10 applications hosted on the target domain ranked by leaked credential volume.
third_party_applications
array
Top 10 external applications used by the target domain's employees ranked by leaked credential volume.
consumer_incident_timeline
array
Monthly timeline of consumer-side credential exposures from 2017 onward.
corporate_incident_timeline
array
Monthly timeline of corporate-side credential exposures from 2017 onward.
latest_consumer_events
array
Most recent consumer-side leak events by application and date.
latest_corporate_events
array
Most recent corporate-side leak events by application and date.
country_stats
array
Distribution of consumer-side leaked credentials by country of the infected machine.
Consumer vs. Corporate
Several metrics come in matched consumer and corporate variants. The distinction is the same as in the Consumer Leaks and Corporate Leaks endpoints:
Consumer metrics match on the website where the credential was captured — they describe exposure of accounts on the target domain.
Corporate metrics match on the email domain of the username — they describe exposure of the target organization's employees regardless of where the credential was captured.
Request Example
Response Schema
Common Envelope
Every successful response uses the same outer structure:
success
boolean
true when the request completed successfully.
remaining_daily_calls
integer
Remaining requests on the daily quota for the current API key.
target_domain
string
The resolved domain or subdomain used for the lookup.
results
object or array
The metric payload. Shape depends on the requested metric.
The shape of results is documented per metric below.
Metric: consumer_count
consumer_countReturns the total number of credentials captured on the target domain's websites, broken out by source.
combolist_consumer_count
integer
Records sourced from credential combolists.
stealer_consumer_count
integer
Records sourced from infostealer logs.
Metric: corporate_count
corporate_countReturns the total number of credentials whose username belongs to the target domain's email domain, broken out by source.
stealer_corporate_count
integer
Records sourced from infostealer logs.
combolist_corporate_count
integer
Records sourced from credential combolists.
Metric: computer_count
computer_countReturns the number of distinct infected machines that have produced credential records associated with the target domain, either through the website domain or the email domain.
Metric: ip_address_count
ip_address_countReturns the number of unique IP addresses observed across all infected machines associated with the target domain.
Metric: application_count
application_countReturns the number of distinct applications (resolved as subdomains of the target domain) that appear in leak records.
Metric: third_party_application_count
third_party_application_countReturns the number of distinct external applications that employees of the target domain have logged into using corporate credentials.
Metric: applications
applicationsReturns the top 10 applications hosted on the target domain, ranked by credential exposure volume.
application
string
The application identifier (subdomain).
count
integer
Total credentials captured for that application.
Metric: third_party_applications
third_party_applicationsReturns the top 10 external applications used by employees of the target domain, ranked by credential exposure volume.
Field structure is identical to the applications metric.
Metric: consumer_incident_timeline
consumer_incident_timelineReturns a monthly time series of consumer-side credential exposures from 2017 onward, broken out by source. Each (year, month, source) tuple is a separate entry.
Year
integer
Year of the bucket.
Month
integer
Month of the bucket (1–12).
Count
integer
Number of credentials in that bucket.
source
string
Either stealer or combolist.
Results are sorted ascending by year, then month.
Metric: corporate_incident_timeline
corporate_incident_timelineSame schema as consumer_incident_timeline, but matched on the email domain of the username instead of the website domain.
Metric: latest_consumer_events
latest_consumer_eventsReturns the most recent consumer-side leak events grouped by application and date, sorted descending by date.
application
string
The application identifier (subdomain).
records
integer
Number of records in that application/date group.
type
string
Either stealer or combolist.
date
string (date)
Date of the records.
Metric: latest_corporate_events
latest_corporate_eventsSame schema as latest_consumer_events, but matched on the email domain of the username instead of the website domain.
Metric: country_stats
country_statsReturns the distribution of consumer-side leaked credentials by country of the infected machine. Sorted descending by record count.
country
string
Country attribution as recorded in the underlying stealer log.
total
integer
Total number of records associated with that country.
Empty Result Set
When a list-style metric returns no records, the endpoint responds with an empty array:
For scalar metrics (consumer_count, corporate_count, computer_count, ip_address_count, application_count, third_party_application_count), the response always contains the metric fields with values of 0 rather than an empty array.
Error Responses
All error responses return a JSON body with either an error or message field describing the failure.
400
Invalid request method or non-JSON content type.
{"error": "Invalid request method or content type, expected POST with application/json."}
403
Missing API key.
{"error": "API Key is missing."}
403
Invalid API key.
{"error": "Invalid API Key."}
403
Subscription tier does not permit API access.
{"error": "API calls are only available for Enterprise and Higher tiers. Please upgrade your account."}
200
Daily quota exhausted.
{"success": false, "message": "Daily API request limit exceeded."}
200
Empty or missing query.
{"success": false, "error": "Query can not be empty."}
200
Query is not a valid domain or subdomain.
{"success": false, "error": "Invalid query format. It should be a valid domain or subdomain."}
200
Unrecognized metric value.
{"success": false, "error": "Invalid metric parameter. Accepted values are: consumer_count, corporate_count, ..."}
Validation errors are returned with HTTP
200andsuccess: false. Clients should always inspect thesuccessfield in addition to the HTTP status code.
Best Practices
Dashboard composition: Issue parallel calls — one per metric — to assemble a multi-panel dashboard view. Each call is independent and consumes one quota credit.
Quota planning: Budget for the number of metrics you display, not the number of dashboards rendered. A 12-tile dashboard is 12 calls per render. Consider caching results client-side for short windows when the same domain is viewed repeatedly.
Consumer vs. corporate: Choose the matched pair (
consumer_count+corporate_count,applications+third_party_applications, etc.) when building a comparative dashboard. Mixing them is the most common analyst-facing view of organizational exposure.Timeline range: Both timeline metrics return data from January 2017 onward. Filter or truncate client-side if a narrower window is required.
Subdomain queries: Submitting a subdomain (e.g.
mail.acme.com) restricts results to that subdomain rather than rolling up to the registrable domain. Use the registrable domain (e.g.acme.com) for organization-wide views.Quota monitoring: Track the
remaining_daily_callsfield after each successful response to anticipate quota exhaustion before it occurs.
Support
For technical questions, integration assistance, or to request a quota increase, contact [email protected].
Last updated