Querying Account Stats (V3 Developer API)

Querying Account Stats (V3 Developer API)

If you find you are in need of information about whether you can continue to query - or if you need to hold off to conserve quotas - you can call on our Stats Endpoint.

Understanding your current API usage is helpful, not only for billing purposes, but also within your application. For example, if you are nearing or have exceeded your usage limits for our Enrich API, you may want your application to behave differently, possibly limiting or preventing further requests until you have upgraded your plan to avoid overages. The Account Stats API will give you the insights needed to make these sorts of decisions by providing usage information for the current billing period.

Retrieving Usage

To get current usage, post a request to the Account Stats API. If you are interested in stats for particular APIs only, you can provide those in the statsproperty of the request post body.

Example Code: 

curl -X POST https://api.fullcontact.com/v3/stats.get \
-H "Authorization: Bearer {Your API Key}" \
-H "Content-Type: application/json" \
-d '{"stats":["person","company"]}'

    • Related Articles

    • Generating an API Key

      You can start querying the API right away upon creating a new API Key from the homepage by selecting       "API Keys" from the menu on left side and clicking on the "GENERATE API KEY" button as shown below in the platform. API Keys cannot be seen in ...
    • Issues Verifying Your API Account

      When trying to verify your API account through the Platform via an international number, if you run into any issue please contact us and provide the following: Provide your phone number Country you were in when attempting to verify We will be happy ...
    • How to Cancel Your Account

      How to Cancel Your Account To cancel your account on one of our Premium Plans, fill out the "cancellation" form available on the FullContact Platform. Login to the FullContact Platform. Click on your Avatar in the top right corner of the page, and ...
    • How to Transition to Enrich API

        FullContact’s Enrich API offers these key benefits from the previous API versions: Access to new data add-on functionality to provide additional data enrichment such as social affinities, employment history, demographics, and more. Consumers will ...
    • Webhook ID in Enrich API response

      Can’t find webhook ID in Enrich API response ? We have made some simplifications to our webhook flows in Enrich Person from what we used to have in V2 Person API. In the V2 API, customers could correlate their requests and responses via a request ...