Query Usage Report – API

Screen_Shot_2017-11-16_at_9.34.04_AM.png

The Query Usage Report provides an overview of total queries over a selected date range. The graphical representation of overall query volumes is used to showcase how your query usage changes over time.

The Query Usage Report also allows you to look at query usage by API key, if you have access to multiple API keys on your account. With multiple keys, you can easily go into your Query Usage Report and see query usage for each key. 

 

How do I access my Query Usage Report?

To access your Query Usage Report, simply click through to the Account Settings/Account Overview page from the My Account drop-down menu in the top right corner of the page.

From there, you will see Query usage in the lefthand menu.

Screen_Shot_2017-11-09_at_2.10.57_PM.png

Alternatively, the Query Usage Report can be accessed through your API Dashboard

Once there, there is a Query and usage trends link in the top right corner:Screen_Shot_2017-11-09_at_3.25.13_PM.png

Or, if you hover over the query usage for each of your active API keys, a chart icon will appear that also takes you to the Query Usage Report:

Screen_Shot_2017-11-09_at_3.25.22_PM.png

 

How is the Query Usage Report different than the Lookups feature?

The Lookups tab is being replaced by the more user-friendly Query Usage Report. With the old Lookups tab, you were only able to see the number of queries for a given date range.

The new Query Usage Report gives you a "big picture" view of your usage by allowing you to see it depicted visually over time on the Usage Graph. At the same time, it also provides you with a more granular look at your account's usage. Instead of having to pivot the CSV file to find out your usage by API key, the Query Usage Report has everything listed by API key right below the Usage Graph. 

 

What value will I get from the Query Usage Report?

The Query Usage Report gives greater control over your account, so that you can monitor your query usage as well as usage on an individual, API-level.

If you have either a monthly or annual allotted block of queries, you will be able to monitor how far along you are in this block by selecting your desired date range.

 

How often does this get updated?

The usage report is updated every day. 

 

How can I get a CSV of my lookups?

To obtain a CSV of your queries, scroll down to the Query Details by Month section, located under the usage graph.

Screen_Shot_2017-11-09_at_3.02.53_PM.png 

From there, you will be able to select the month and year that you want to see in more detail. 

Once you have selected those, click on Generate Report to have a CSV file containing your lookups sent to the email associated with the account admin.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk