Skip to main content
GET
/
api
/
external
/
v1
/
usage
GET /usage
curl --request GET \
  --url https://api.trackyard.com/api/external/v1/usage
{
  "usage": [
    {
      "timestamp": "<string>",
      "endpoint": "<string>",
      "status_code": 123,
      "credits_consumed": 123,
      "response_time_ms": 123
    }
  ],
  "total_count": 123,
  "offset": 123,
  "limit": 123
}
Returns a paginated list of your API calls with timestamps, endpoints, status codes, credits consumed, and response times. Cost: Free (does not consume credits)

​
Authentication

Authorization: Bearer your_api_key_here

​
Query Parameters

​
limit
number
default:50
Number of records to return per page.Range: 1-100
​
offset
number
default:0
Pagination offset.

​
Example Request

curl "https://api.trackyard.com/api/external/v1/usage?limit=50&offset=0" \
  -H "Authorization: Bearer $TRACKYARD_API_KEY"

​
Response

​
usage
array
required
Array of usage records.
​
total_count
number
required
Total number of usage records available.
​
offset
number
required
Current pagination offset.
​
limit
number
required
Number of records returned in this response.

​
Example Response

{
  "usage": [
    {
      "timestamp": "2026-02-20T14:22:15Z",
      "endpoint": "/search",
      "status_code": 200,
      "credits_consumed": 1,
      "response_time_ms": 142
    },
    {
      "timestamp": "2026-02-20T14:20:08Z",
      "endpoint": "/download-track",
      "status_code": 200,
      "credits_consumed": 1,
      "response_time_ms": 387
    },
    {
      "timestamp": "2026-02-20T14:18:32Z",
      "endpoint": "/me",
      "status_code": 200,
      "credits_consumed": 0,
      "response_time_ms": 28
    }
  ],
  "total_count": 127,
  "offset": 0,
  "limit": 50
}

​
Use Cases

Track which endpoints are being called and when.
Check status codes and response times to identify failures.
See which operations are consuming the most credits.
Integrate usage data into your internal analytics.

​
Pagination Example

import requests

API_KEY = "your_api_key_here"
BASE = "https://api.trackyard.com/api/external/v1"
headers = {"Authorization": f"Bearer {API_KEY}"}

# Fetch all usage records
all_records = []
offset = 0
limit = 100

while True:
    response = requests.get(
        f"{BASE}/usage?limit={limit}&offset={offset}",
        headers=headers
    )
    data = response.json()
    
    all_records.extend(data["usage"])
    
    if len(data["usage"]) < limit:
        break  # No more records
    
    offset += limit

print(f"Total records fetched: {len(all_records)}")

​
Next Steps

Account Metadata

Get tier, credits, and rate limits

Rate Limits

Understand credit consumption