GET API USAGE (V2)
GET /v2/getapiusage
API DEFAULT URL: https://api.zerobounce.net/v2/getapiusage
API U.S.A. URL*: https://api-us.zerobounce.net/v2/getapiusage
API EU URL: https://api-eu.zerobounce.net/v2/getapiusage
*This endpoint uses servers located within the United States. By utilizing this endpoint, you acknowledge and consent to your data being processed on servers in the United States.
URL Parameters
- ParameterDescription
- api_keyYour API Key can be found in your account.
- start_dateThe start date of when you want to view API usage. (format: yyyy-mm-dd)
- end_dateThe end date of when you want to view API usage. (format: yyyy-mm-dd)
https://api.zerobounce.net/v2/getapiusage?api_key=your-api-key&start_date=2018-01-01&end_date=2019-12-12
https://api-us.zerobounce.net/v2/getapiusage?api_key=your-api-key&start_date=2018-01-01&end_date=2019-12-12
https://api-eu.zerobounce.net/v2/getapiusage?api_key=your-api-key&start_date=2018-01-01&end_date=2019-12-12
The API will return these results in a JSON format using the "getapiusage" method.
The API will return these results in a JSON format using the "getapiusage" method.
- ParameterDescription
- totalTotal number of times the API has been called
- status_validTotal valid email addresses returned by the API
- status_invalidTotal invalid email addresses returned by the API
- status_catch_allTotal catch-all email addresses returned by the API
- status_do_not_mailTotal do not mail email addresses returned by the API
- status_spamtrapTotal spamtrap email addresses returned by the API
- status_unknownTotal unknown email addresses returned by the API
- sub_status_toxicTotal number of times the API has a sub status of "toxic"
- sub_status_disposableTotal number of times the API has a sub status of "disposable"
- sub_status_role_basedTotal number of times the API has a sub status of "role_based"
- sub_status_possible_trapTotal number of times the API has a sub status of "possible_trap"
- sub_status_global_suppressionTotal number of times the API has a sub status of "global_suppression"
- sub_status_timeout_exceededTotal number of times the API has a sub status of "timeout_exceeded"
- sub_status_mail_server_temporary_errorTotal number of times the API has a sub status of "mail_server_temporary_error"
- sub_status_mail_server_did_not_respondTotal number of times the API has a sub status of "mail_server_did_not_respond"
- sub_status_greylistedTotal number of times the API has a sub status of "greylisted"
- sub_status_antispam_systemTotal number of times the API has a sub status of "antispam_system"
- sub_status_does_not_accept_mailTotal number of times the API has a sub status of "does_not_accept_mail"
- sub_status_exception_occurredTotal number of times the API has a sub status of "exception_occurred"
- sub_status_failed_syntax_checkTotal number of times the API has a sub status of "failed_syntax_check"
- sub_status_mailbox_not_foundTotal number of times the API has a sub status of "mailbox_not_found"
- sub_status_unroutable_ip_addressTotal number of times the API has a sub status of "unroutable_ip_address"
- sub_status_possible_typoTotal number of times the API has a sub status of "possible_typo"
- sub_status_no_dns_entriesTotal number of times the API has a sub status of "no_dns_entries"
- sub_status_role_based_catch_allTotal role based catch alls the API has a sub status of "role_based_catch_all"
- sub_status_mailbox_quota_exceededTotal number of times the API has a sub status of "mailbox_quota_exceeded"
- sub_status_forcible_disconnectTotal forcible disconnects the API has a sub status of "forcible_disconnect"
- sub_status_failed_smtp_connectionTotal failed SMTP connections the API has a sub status of "failed_smtp_connection"
- sub_status_mx_forwardTotal number times the API has a sub status "mx_forward"
- start_dateStart date of query. (format: yyyy/mm/dd)
- end_dateEnd date of query. (format: yyyy/mm/dd)
GET API USAGE CODE SAMPLES
ENDPOINT RESPONSE
Successful Response
{
"total": 120,
"status_valid": 17,
"status_invalid": 69,
"status_catch_all": 9,
"status_do_not_mail": 16,
"status_spamtrap": 0,
"status_unknown": 6,
"sub_status_toxic": 0,
"sub_status_disposable": 1,
"sub_status_role_based": 1,
"sub_status_possible_trap": 0,
"sub_status_global_suppression": 14,
"sub_status_timeout_exceeded": 0,
"sub_status_mail_server_temporary_error": 0,
"sub_status_mail_server_did_not_respond": 0,
"sub_status_greylisted": 6,
"sub_status_antispam_system": 0,
"sub_status_does_not_accept_mail": 27,
"sub_status_exception_occurred": 0,
"sub_status_failed_syntax_check": 20,
"sub_status_mailbox_not_found": 12,
"sub_status_unroutable_ip_address": 0,
"sub_status_possible_typo": 0,
"sub_status_no_dns_entries": 10,
"sub_status_role_based_catch_all": 0,
"sub_status_mailbox_quota_exceeded": 0,
"sub_status_forcible_disconnect": 0,
"sub_status_failed_smtp_connection": 0,
"sub_status_leading_period_removed": 0,
"sub_status_alias_address": 2,
"sub_status_mx_forward": 0,
"sub_status_alternate": 0,
"sub_status_blocked": 0,
"sub_status_allowed": 0,
"start_date": "1/1/2023",
"end_date": "1/30/2024"
}Error Response - API Key
{"error":"Invalid API Key"}Error Response - Date
{"error":"Invalid Date"}GetApiUsage V2 Rate Limits
Bad requests (200 times in 1 hour) to the following endpoints will result in a temporary block for 1 hour:
- https://api.zerobounce.net/v2/getapiusage
- https://api-us.zerobounce.net/v2/getapiusage
- https://api-eu.zerobounce.net/v2/getapiusage
*This endpoint uses servers located within the United States. By utilizing this endpoint, you acknowledge and consent to your data being processed on servers in the United States.