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 HTTPS request for Usage Query begins with the URL structure:

https://partnerapi.zoominfo.com/partnerapi/v4/usage/query?

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

Input Parameters – Usage

The following table contains the Input Parameters for Usage.

Example Usage Query

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

https://partnerapi.zoominfo.com/partnerapi/v4/usage/query?pc=PartnerCode& queryTypeOptions=company_search_query,person_detail&key=OAuthAccessToken

Example XML output:

<?xml version="1.0" encoding="UTF-8"?>
<usageQueryResponse xmlns="http://partnerapi.zoominfo.com/partnerapistatic/xsd/V4">
   <inputParameters>
      <parameter>
         <name>queryTypeOptions</name>
         <value>company_search_query,person_detail</value>
      </parameter>
   </inputParameters>
   <queryResult>
      <overallUsageLimit>
         <currentQueryUsage>16</currentQueryUsage>
         <usageRemaining>99984</usageRemaining>
         <queryLimit>100000</queryLimit>
         <limitType>Soft Limit</limitType>
         <limitTerms>Per Month</limitTerms>
         <cleanLimit>-1</cleanLimit>
         <cleanCount>0</cleanCount>
      </overallUsageLimit>
      <queryTypeUsageLimits>
         <queryType>company_search_query</queryType>
         <queryTypeQueryLimit>
            <currentQueryUsage>2</currentQueryUsage>
            <usageRemaining>99998</usageRemaining>
            <queryLimit>100000</queryLimit>
            <limitType>Soft Limit</limitType>
            <limitTerms>Per Month</limitTerms>
         </queryTypeQueryLimit>
         <queryTypeRecordCountLimit>
            <currentQueryUsage>70</currentQueryUsage>
            <usageRemaining>Unlimited</usageRemaining>
            <queryLimit>Unlimited</queryLimit>
            <limitType>Soft Limit</limitType>
            <limitTerms>Per Month</limitTerms>
         </queryTypeRecordCountLimit>
         <resultsPerQueryLimit>500</resultsPerQueryLimit>
      </queryTypeUsageLimits>
      <queryTypeUsageLimits>
         <queryType>person_detail</queryType>
         <queryTypeQueryLimit>
            <currentQueryUsage>0</currentQueryUsage>
            <usageRemaining>100000</usageRemaining>
            <queryLimit>100000</queryLimit>
            <limitType>Soft Limit</limitType>
            <limitTerms>Per Month</limitTerms>
         </queryTypeQueryLimit>
         <queryTypeRecordCountLimit>
            <currentQueryUsage>0</currentQueryUsage>
            <usageRemaining>Unlimited</usageRemaining>
            <queryLimit>Unlimited</queryLimit>
            <limitType>Soft Limit</limitType>
            <limitTerms>Per Month</limitTerms>
         </queryTypeRecordCountLimit>
         <resultsPerQueryLimit>1</resultsPerQueryLimit>
      </queryTypeUsageLimits>
   </queryResult>
</usageQueryResponse>

Output Parameters – Usage

The following table contains the Output Parameters for Usage.