GetHistoryReports | Voximplant Voice AI

curl -X POST https://api.voximplant.com/platform_api/GetHistoryReports \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "history_report_id": 34,
      "history_type": "calls",
      "created": "2015-10-07 18:40:01",
      "format": "csv",
      "completed": "2015-10-07 18:40:02",
      "error": {
        "code": 24,
        "msg": "No disc space"
      }
    },
    {
      "history_report_id": 35,
      "history_type": "calls",
      "created": "2015-10-07 18:40:05",
      "format": "csv",
      "completed": "2015-10-07 18:40:06",
      "file_name": "call_history_2015-09-07_(12_of_12).csv",
      "file_size": 2511,
      "download_size": 687,
      "download_count": 1,
      "last_downloaded": "2015-10-07 18:40:18",
      "store_until": "2015-10-14",
      "calculated_data": {
        "session_count": 12,
        "total_session_count": 12
      }
    },
    {
      "history_report_id": 36,
      "history_type": "transactions",
      "created": "2015-10-07 18:40:10",
      "format": "csv",
      "completed": "2015-10-07 18:40:11",
      "file_name": "transaction_history_2015-09-07_(10.2_8.15).csv",
      "file_size": 3511,
      "download_size": 698,
      "download_count": 2,
      "last_downloaded": "2015-10-07 18:40:19",
      "store_until": "2015-10-14",
      "calculated_data": {
        "transaction_count": 120,
        "total_transaction_count": 120,
        "start_balance": "10.2 USD",
        "end_balance": "8.15 USD",
        "account_id": 1
      }
    },
    {
      "history_report_id": 37,
      "history_type": "transactions",
      "created": "2015-10-07 18:40:15",
      "format": "csv"
    }
  ],
  "total_count": 7,
  "count": 3
}

Allowed roles: Owner, Admin, Developer, Supervisor, Accountant, Support, Payer.

Example request: Get all the reports.

Gets the list of history reports and their statuses. The method returns info about the reports made via [GetCallHistoryAsync], [GetTransactionHistoryAsync], [GetAuditLogAsync] and [GetBriefCallHistory] asynchronous methods. Note that the **file_size** field in response is valid only for the video calls. Allowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`. **Example request:** Get all the reports.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

history_report_idintegerOptional

The history report ID to filter

history_typelist of stringsOptional

The history report type list separated by semicolons (;). Use the ‘all’ value to select all history report types. The following values are possible: calls, calls_brief, transactions, audit, call_list, transactions_on_hold

created_fromstringOptional

The UTC creation from date filter in 24-h format: YYYY-MM-DD HH:mm:ss

created_tostringOptional

The UTC creation to date filter in 24-h format: YYYY-MM-DD HH:mm:ss

is_completedbooleanOptional

Whether the report is completed

desc_orderbooleanOptionalDefaults to false

Whether to get records in the descent order

countintegerOptionalDefaults to 20

The max returning record count

offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

application_idlist of integersOptional

The application ID to filter. Can be a list separated by semicolons (;). Use the ‘all’ value to select all applications

Response

Successful response

resultlist of objects

total_countinteger

The total found reports count

countinteger

The returned reports count