Sorry, we didn't find any relevant articles for you.
Please fill out the contact form below and we will reply as soon as possible.
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.
The following table contains the Input Parameters for Usage.
Field Name |
Required |
Notes |
pc |
yes |
Partner Code (name) assigned to you. |
key |
yes |
OAuth access token returned from the OAuth token request: https://partnerapi.zoominfo.com/partnerapi/v2/token |
outputType |
no |
The output type of the response (case insensitive): xml or json |
queryTypeOptions |
no |
The following are available options (case insensitive):
|
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>
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 |
Contact our award-winning customer care team.