Get Credits Consumption
Retrieve daily credit consumption data for your team showing the number of API records returned per day. Use this endpoint to monitor usage trends, track spending, and optimize your API integration.
Authorization
Bearer In: header
Query Parameters
Start datetime in ISO format (e.g., 2023-01-01T00:00:00)
End datetime in ISO format (e.g., 2023-01-01T23:59:59)
- search_pattern
- endpoint
- origin
Only charges associated with this canonical search pattern.
- api
- app
- web
- mcp
- admin_mcp
Filter by search type.
- jobs
- companies
- technologies
Match any exact request URL path; unassigned selects charges without a recorded endpoint. Intersects the singular endpoint filter.
Match any HTTP response status code.
Match any recorded origin; webhook requires a linked webhook event and unassigned selects missing attribution. Intersects the singular origin filter.
^/[^?#]*$Exact request URL path, e.g. /v1/jobs/search; host and query string are ignored.
IANA timezone, such as Europe/Madrid.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.theirstack.com/v0/teams/credits_consumption"[
{
"api_credits_consumed": 0,
"endpoints": [
"string"
],
"group_key": "string",
"group_name": "string",
"origins": [
"string"
],
"period_start": "2019-08-24T14:15:22Z",
"search_pattern_filters": {},
"search_pattern_key": "string",
"search_pattern_name": "string",
"search_type": "jobs",
"ui_credits_consumed": 0
}
]{
"error": {
"code": "E-001",
"description": "string",
"title": "Not allowed exception"
},
"request_id": null
}{
"error": {
"code": "E-001",
"description": "string",
"title": "Not allowed exception"
},
"request_id": null
}{
"error": {
"code": "E-001",
"description": "string",
"title": "Not allowed exception"
},
"request_id": null
}{
"error": {
"code": "E-001",
"description": "string",
"title": "Not allowed exception"
},
"request_id": null
}How is this guide?
Last updated on
Get Credit Balance GET
Retrieve your team's current credit balance including remaining credits available for API calls, searches, and data exports across all endpoints.
Get Companies Per Company Country Code GET
Retrieve all ISO country codes with the number of companies headquartered in each country. Use this endpoint for geographic distribution analysis. Calls to this endpoint are free and do not consume any API credits.
