Usage Tracking

📊 Track Customer Usage

Retrieve usage statistics for an individual customer to monitor transcription activity, costs, and breakdowns by language, token, or time period.

---

📥 Get Customer Usage

URL: GET /api/v3/reseller/customer/{id}/usage

Headers

Parameter	Description
x-zoom-s2t-key	Scriptix Reseller API Token

Path Parameters

Name	Description
id	ID of the customer

Query Parameters

Name	Type	Default	Description
limit	integer	10	(Optional) Number of records to return (max: 1000)
offset	integer	0	(Optional) Pagination offset
view	string	invoice	View type: invoice, day, week, month, or year
split_by	string	-	(Optional) Split by: language, token, subscription, or period

---

✅ Response Codes

Status Code	Description
200	Usage overview returned successfully
400	Bad request – check query parameters
401	Unauthorized – missing or invalid token
403	Forbidden – token lacks permission
404	Not found – customer ID doesn't exist
500	Internal error – contact support if persistent

---

📦 Example: Split by Week

{
  "result": [
    {
      "units_used": 5926,
      "usage_period_start": "2020-12-22",
      "usage_period_end": "2020-12-24",
      "language": "fr-fr",
      "token_name": "TV",
      "subscription_id": 1414
    }
  ],
  "count": 1,
  "total_results": 1
}

📦 Example: Invoice View

{
  "result": [
    {
      "usage_period_start": "2020-12-01",
      "usage_period_end": "2021-01-01",
      "units_used": 840000,
      "cost": 10000.01,
      "subscription_id": 1182
    }
  ],
  "count": 1,
  "total_results": 1
}

---

🧠 Use Cases

• Analyze monthly or weekly customer usage
• Track costs and subscription performance
• Split usage data by token or language for billing granularity

---

📘 Next Steps

• Customer Management – Manage client records
• Authentication – Secure your requests
• Custom Models – Usage per model coming soon