Usage

The Usage API returns your remaining usage (query limit – current query usage) and additional usage limits information of query types based on input criteria. The access rights on query types might restrict the returned output. Query usage information is only updated once a day. The HTTP request for Usage Query begins with the URL structure:

http://partnerapi.zoominfo.com/partnerapi/usage/query?

Note: This API call is not available for Salesforce partners.

Input Parameters – Usage

The following table contains the Input Parameters for Usage.

Field Name
Required
Notes
pc
yes
Partner  Code (name) assigned to you.
key
yes
The key is made up of a string consisting of parameters concatenated together, and then encrypted with MD5. Parameters are:
  • Partner password
  • Today's day of the month (not padded with zero)
  • Today's month (not padded with zero)
  • Today's year (4 digits)
outputType
no
The output type of the response (case insensitive): xml or json
queryTypeOptions
no
The following are available options (case insensitive):
  • people_search_query
  • person_detail
  • person_match
  • company_search_query
  • company_detail
  • company_match
  • person_match_existence
  • form_complete_person_match
  • form_complete_person_match_existence
  • enhanced_api_person_match
  • enhanced_person_match_existence


Example Usage Query

The following shows an example Usage query for company_search_query and person_detail:

http://partnerapi.zoominfo.com/partnerapi/usage/query?pc=PartnerCode& queryTypeOptions=company_search_query,person_detail&key=EncryptedKey

Example XML output:

<?xml version="1.0" encoding="utf-8"?>

<usageQueryResponse
xmlns="http://partnerapi.zoominfo.com/partnerapistatic/xsd/V1/UsageQueryResponse.xsd">
 <inputParameters>
 <parameter>
 <name>queryTypeOptions</name>
 <value>company_search_query,person_detail</value>
 </parameter>
 </inputParameters>
 <queryResult>
 <overallUsageLimit>
 <currentQueryUsage>1000</currentQueryUsage>
 <usageRemaining>4000</usageRemaining>
 <queryLimit>5000</queryLimit>
 <limitTerms>Per Month</limitTerms>
 <limitType>Soft Limit</limitType>
 </overallUsageLimit>
 <queryTypeUsageLimits>
 <queryType>company_search_query</queryType>
 <queryTypeQueryLimit>
 <currentQueryUsage>1500</currentQueryUsage>
 <usageRemaining>3500</usageRemaining>
 <queryLimit>5000</queryLimit>
 <limitTerms>Per Month</limitTerms>
 <limitType>Soft Limit</limitType>
 </queryTypeQueryLimit>
 <resultsPerQueryLimit>5000</resultsPerQueryLimit>
 </queryTypeUsageLimits>
 <queryTypeUsageLimits>
 <queryType>person_detail</queryType>
 <queryTypeQueryLimit>
 <currentQueryUsage>2000</currentQueryUsage>
 <usageRemaining>3000</usageRemaining>
 <queryLimit>5000</queryLimit>
 <limitTerms>Per Month</limitTerms>
 <limitType>Soft Limit</limitType>
 </queryTypeQueryLimit>
 <resultsPerQueryLimit>1</resultsPerQueryLimit>
 </queryTypeUsageLimits>
 </queryResult>
</usageQueryResponse>

Output Parameters – Usage

The following table contains the Output Parameters for Usage.

Group
Parent Name
Child Name
Notes
Default
overallUsageLimit

Current limit for overall use of APIs
currentQueryUsage
Amount of queries used
usageRemaining
Amount of queries remaining
queryLimit
Pre-established limit on API queries
limitTerms
Terms of limit. Ex. per month, per quarter, or per year.
limitType
Type of limit. Ex. hard limit, soft limit
Optional
people_search_query
 Usage information on Person Search queries.
currentQueryUsage
Amount of queries used
usageRemaining
Amount of queries remaining
queryLimit
Pre-established limit on API queries
limitTerms
Terms of limit. Ex. per month, per quarter, or per year.
limitType
Type of limit. Ex. hard limit, soft limit
resultsPerQueryLimit
Limit to the amount of results that will appear on a page.
person_detail
 Usage information on Person Detail queries.
currentQueryUsage
Amount of queries used
usageRemaining
Amount of queries remaining
queryLimit
Pre-established limit on API queries
limitTerms
Terms of limit. Ex. per month, per quarter, or per year.
limitType
Type of limit. Ex. hard limit, soft limit
resultsPerQueryLimit
1
person_match
 Usage information on Person Match queries
currentQueryUsage
Amount of queries used
usageRemaining
Amount of queries remaining
queryLimit
Pre-established limit on API queries
limitTerms
Terms of limit. Ex. per month, per quarter, or per year.
limitType
Type of limit. Ex. soft limit
resultsPerQueryLimit
10
company_search_query
 Usage information on Company Search queries
currentQueryUsage
Amount of queries used
usageRemaining
Amount of queries remaining
queryLimit
Pre-established limit on API queries
limitTerms
Terms of limit. Ex. per month, per quarter, or per year.
limitType
Type of limit. Ex. hard limit, soft limit
resultsPerQueryLimit
Limit to the amount of results that will appear on a page.
company_detail
 Usage information on Company Detail queries
currentQueryUsage
Amount of queries used
usageRemaining
Amount of queries remaining
queryLimit
Pre-established limit on API queries
limitTerms
Terms of limit. Ex. per month, per quarter, or per year.
limitType
Type of limit. Ex. hard limit, soft limit
resultsPerQueryLimit
1
company_match
 Usage information on Company Match queries
currentQueryUsage
Amount of queries used
usageRemaining
Amount of queries remaining
queryLimit
Pre-established limit on API queries
limitTerms
Terms of limit. Ex. per month, per year.
limitType
Type of limit. Ex. hard limit, soft limit
resultsPerQueryLimit
10

Was this article helpful?

Can’t find what you’re looking for?

Contact our award-winning customer care team.