Overview

This article describes the different ways you can track your API credit usage no matter your plan type.

Home page

The Home page in the API Dashboard provides a high level overview of usage across all active plans as well as usage statistics including match rate and errors.

To learn more about the Home page, check out this article.

Usage page

The Usage page in the API Dashboard is the main method for a detailed view of how many credits you've used over a defined date range and how many credits are remaining in your plan.

The aggregated metrics, Total credits used, Total credits remaining, Percent usage, and Overages (if enabled for your account) are updated every 15 minutes.

The Usage Chart and Usage Table (toggled by clicking the table icon above the chart) are updated in near-real time so there may be a slight mismatch in the aggregated metrics. 

To learn more about how to use the Usage page, check out this article.

API Response Headers

Each response from an API request contains a header. You can use this to check credit usage in real-time.

A response header from a Person Enrichment API call might look like this:

{
"Date": "Wed, 13 Nov 2024 23:54:04 GMT",
"Content-Type": "application/json",
"Content-Length": "123",
"Connection": "keep-alive",
"Server": "gunicorn",
"Strict-Transport-Security": "max-age=31536000; preload",
"X-Lifetime-Used": "116",
"X-Call-Credits-Spent": "1",
"X-Call-Credits-Type": "enrich",
"X-TotalLimit-Remaining": "99",
"X-TotalLimit-Purchased-Remaining": "99",
"X-TotalLimit-Overages-Remaining": "0",
"X-RateLimit-Limit": "{'minute': 100}",
"X-RateLimit-Reset": "2024-11-13 23:55:05",
"X-RateLimit-Remaining": "{'minute': 99}",
"Vary": "Accept-Encoding",
"Access-Control-Allow-Origin": "*"
}

In the above example, you can see that the total credits spent is 1, indicated by X-Call-Credits-Spent and the number of credits remaining is 99 indicated by X-TotalLimit-Remaining.

You can use these values to create custom alerting when you hit a specific amount of credits remaining. To learn more about each field included in the header response, please view our documentation.

Usage Alerts

If you don't want to implement and maintain custom alerting, you can use our Usage Alert feature in the API Dashboard. This allows you to configure credit usage threshold alerts and receive real-time email notifications upon meeting that threshold.

To learn more about setting up Usage Alerts, check out this article.

Feedback

Is there a missing feature you'd like to see? We want to hear from you! 

Submit a feature request or vote on existing feature requests here: People Data Labs Roadmap