> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# メディア使用量を一覧表示

> 翻訳とリップシンクの分数消費、課金、返還の履歴をページ分割して取得します。必要に応じて日付、言語、状態、プロジェクトで絞り込めます。

翻訳とリップシンクの分数消費、課金、返還の履歴をページ分割して取得します。必要に応じて日付、言語、状態、プロジェクトで絞り込めます。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/usage_logs_list
```

## 認証と権限

**x-api-key** `string` *required*

このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。

必要な権限: `usage:read`.

有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

## パラメーター

**view** `string`

テキスト値。

許容値: "translation", "project". デフォルト値: "translation".

**translatedVersionId** `string`

テキスト値。

最小文字数: 1. 最大文字数: 200. パターン: `^[^/]+$`.

**project** `string`

テキスト値。

最小文字数: 1. 最大文字数: 200.

**targetLanguage** `string`

テキスト値。

最小文字数: 2. 最大文字数: 64.

**lipSyncUsage** `string`

テキスト値。

許容値: "all", "none", "standard", "pro", "pro\_2".

**translationStatuses** `array`

値のリスト。要素の構造は完全な入力スキーマを参照してください。

最大要素数: 4.

**billingState** `string`

テキスト値。

許容値: "all", "charged", "refunded", "refund\_pending".

**fromDate** `string`

テキスト値。

形式: "date". パターン: `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$`.

**toDate** `string`

テキスト値。

形式: "date". パターン: `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$`.

**page** `integer`

整数値。

最小値: 1. 最大値: 100000. デフォルト値: 1.

**pageSize** `integer`

整数値。

最小値: 1. 最大値: 100. デフォルト値: 25.

> [accordion] 完全な入力スキーマ
>
> 以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "view": {
>       "default": "translation",
>       "type": "string",
>       "enum": ["translation", "project"]
>     },
>     "translatedVersionId": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 200,
>       "pattern": "^[^/]+$"
>     },
>     "project": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 200
>     },
>     "targetLanguage": {
>       "type": "string",
>       "minLength": 2,
>       "maxLength": 64
>     },
>     "lipSyncUsage": {
>       "type": "string",
>       "enum": ["all", "none", "standard", "pro", "pro_2"]
>     },
>     "translationStatuses": {
>       "maxItems": 4,
>       "type": "array",
>       "items": {
>         "type": "string",
>         "enum": ["in_progress", "completed", "failed", "timed_out"]
>       }
>     },
>     "billingState": {
>       "type": "string",
>       "enum": ["all", "charged", "refunded", "refund_pending"]
>     },
>     "fromDate": {
>       "type": "string",
>       "format": "date",
>       "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
>     },
>     "toDate": {
>       "type": "string",
>       "format": "date",
>       "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
>     },
>     "page": {
>       "default": 1,
>       "type": "integer",
>       "minimum": 1,
>       "maximum": 100000
>     },
>     "pageSize": {
>       "default": 25,
>       "type": "integer",
>       "minimum": 1,
>       "maximum": 100
>     }
>   },
>   "additionalProperties": false
> }
> ```

## リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_logs_list' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"view":"translation","fromDate":"2026-10-01","toDate":"2026-10-16","page":1,"pageSize":25}'
```

```javascript JavaScript theme={null}
const input = {
  view: 'translation',
  fromDate: '2026-10-01',
  toDate: '2026-10-16',
  page: 1,
  pageSize: 25,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_logs_list', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
```

```python Python theme={null}
import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/usage_logs_list",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"view": "translation", "fromDate": "2026-10-01", "toDate": "2026-10-16", "page": 1, "pageSize": 25},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```

## レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。

ページ分割された翻訳またはプロジェクトの使用量行、正規化済みフィルター、および一致するすべての行の分数合計を返します。

```json HTTP 200 theme={null}
{
  "data": {
    "exportedAt": 1792152000000,
    "scope": "user",
    "plan": "pro",
    "view": "translation",
    "filters": {
      "view": "translation",
      "lipSyncUsage": "all",
      "translationStatuses": [],
      "billingState": "all",
      "fromDate": "2026-10-01",
      "toDate": "2026-10-16"
    },
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "totalItems": 1,
      "totalPages": 1
    },
    "totals": {
      "translationBaseMinutes": 2,
      "lipSyncExtraMinutes": 0,
      "lipSyncProExtraMinutes": 0,
      "lipSyncPro2ExtraMinutes": 0,
      "totalChargedMinutes": 2,
      "refundedMinutes": 0,
      "netUsedMinutes": 2
    },
    "rows": [
      {
        "projectId": "project_123",
        "projectName": "Product launch",
        "workId": "work_123",
        "translatedVersionId": "version_123",
        "sourceLanguage": "english",
        "targetLanguage": "french",
        "startedAt": 1792065600000,
        "endedAt": 1792065720000,
        "startedByUserId": "user_123",
        "translationStatus": "completed",
        "lipSyncUsage": "none",
        "lipSyncStatus": "not_used",
        "runNumber": 1,
        "totalChargedMinutes": 2,
        "refundedMinutes": 0,
        "netUsedMinutes": 2,
        "billingState": "charged"
      }
    ]
  }
}
```

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.exportedAt` | 結果が生成された時刻（Unix タイムスタンプ、ミリ秒）。 |
| `data.scope` | 個人アカウントは user、所有または参加しているチームは team。 |
| `data.plan` | ワークスペースオーナーのプラン。 |
| `data.view` | 要求した表示に対応する translation または project。 |
| `data.filters` | 正規化された適用フィルター。ページ分割情報は別途返されます。 |
| `data.pagination.page` | 利用可能なページ範囲を適用した後に返されるページ。 |
| `data.pagination.pageSize` | 1 ページあたりの行数。 |
| `data.pagination.totalItems` | ページ分割前の一致する行の総数。 |
| `data.pagination.totalPages` | ページ数。結果が空の場合も少なくとも1です。 |
| `data.totals.translationBaseMinutes` | 一致した行全体で消費された基本翻訳分数。 |
| `data.totals.lipSyncExtraMinutes` | 追加で課金された Standard リップシンクの分数。 |
| `data.totals.lipSyncProExtraMinutes` | 課金された追加のProリップシンク分数。 |
| `data.totals.lipSyncPro2ExtraMinutes` | 追加で課金された Pro 2 リップシンク分数。 |
| `data.totals.totalChargedMinutes` | 返還前の課金分数合計。 |
| `data.totals.refundedMinutes` | 返還された分数。 |
| `data.totals.netUsedMinutes` | 課金された分数から返還された分数を引いた値。 |
| `data.rows` | 翻訳表示では翻訳の行、プロジェクト表示ではプロジェクトごとの集計。 |
| `data.rows[].projectId` | プロジェクト識別子。 |
| `data.rows[].projectName` | プロジェクトの表示名。 |
| `data.rows[].workId` | 言語別作業データの識別子。翻訳表示で含まれます。 |
| `data.rows[].translatedVersionId` | 翻訳バージョンの識別子。翻訳表示で含まれます。 |
| `data.rows[].sourceLanguage` | ソース言語。 |
| `data.rows[].targetLanguage` | 翻訳表示の翻訳先言語。 |
| `data.rows[].startedAt` | 翻訳表示の、翻訳開始タイムスタンプ。ミリ秒単位。 |
| `data.rows[].endedAt` | 翻訳表示の、任意の翻訳・リップシンク終了タイムスタンプ。ミリ秒単位。 |
| `data.rows[].startedByUserId` | 翻訳表示の、任意の開始元アカウント識別子。 |
| `data.rows[].translationStatus` | 翻訳表示では in\_progress、completed、failed、timed\_out のいずれか。 |
| `data.rows[].lipSyncUsage` | 翻訳表示では none、standard、pro、pro\_2 のいずれか。 |
| `data.rows[].lipSyncStatus` | 翻訳表示では not\_used、in\_progress、completed、failed、timed\_out のいずれか。 |
| `data.rows[].runNumber` | 翻訳表示の、このプロジェクトと翻訳先言語内での翻訳実行番号。 |
| `data.rows[].createdAt` | プロジェクト表示の、プロジェクト作成タイムスタンプ。ミリ秒単位。 |
| `data.rows[].targetLanguages` | プロジェクト表示で、プロジェクト集計に含まれる翻訳先言語。 |
| `data.rows[].runCount` | プロジェクト表示の、プロジェクトに一致する翻訳実行の件数。 |
| `data.rows[].translationSummary` | プロジェクト表示の件数：inProgress、completed、failed、timedOut、retryCount。 |
| `data.rows[].lipSyncSummary` | プロジェクト表示の件数：inProgress、completed、failed、timedOut、retryCount、notUsed。 |
| `data.rows[].totalChargedMinutes` | 返還前の、この行の課金分数合計。 |
| `data.rows[].refundedMinutes` | この行の返還分数。 |
| `data.rows[].netUsedMinutes` | この行の課金分数から返還分数を引いた値。 |
| `data.rows[].billingState` | charged、refunded、refund\_pending のいずれか。 |

## 操作の注意事項

* view のデフォルトは translation、page は 1、pageSize は 25 です。pageSize の上限は 100 です。
* 日付フィルターは YYYY-MM-DD を使用し、Europe/Paris の翻訳開始日と比較します。fromDate は toDate より後にはできません。
* project は大文字と小文字を区別せず、プロジェクト名と ID を検索します。translatedVersionId は translation 表示でバージョン ID に部分一致し、project 表示では無視されます。
* 合計は、ページ分割前の一致するすべての翻訳行を対象とします。プロジェクト表示では、それらの行をプロジェクト別に集計します。
* 公開される行には、開始したユーザーのメールアドレスや未加工の処理エラーメッセージは含まれません。

## 使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `VALIDATION_ERROR` | JSONオブジェクトに未対応のフィールド、無効な値、または必須引数の欠落があります。 |
| 401 | `API_KEY_EXPIRED` | API キーの有効期限が切れています。 |
| 401 | `INVALID_API_KEY` | 有効期限内の有効な API キーを指定してください。 |
| 401 | `INVALID_CREDENTIAL` | Authorization ヘッダーの形式が不正、または x-api-key と競合しています。 |
| 401 | `MISSING_CREDENTIAL` | 利用可能なヘッダー認証情報が指定されていないか、4096文字を超えています。 |
| 401 | `USER_NOT_FOUND` | 認証情報に対応するアカウントはすでに存在しません。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | `INSUFFICIENT_SCOPE` | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | アカウントの連携上限を確認できませんでした。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 有効な有料サブスクリプションを使用してください。 |
| 403 | `TEAM_MEMBERSHIP_INVALID` | アカウントの現在のチーム所属が、この接続のワークスペースと一致しません。所属情報を更新して再接続してください。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `ACCOUNT_NOT_FOUND` | アカウントまたはアクティブなワークスペースのアカウントが見つかりませんでした。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["usage:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.