# Account Report Resource
## Overview
> \[!NOTE]
>
> **Not a HIPAA Eligible Service**
>
> Voice Insights Reports API is not a HIPAA Eligible Service and should not be used in workflows that are subject to HIPAA.
An **Account Report** provides an overview of aggregated voice metrics and reports at the account level.
## Account Report Properties
### Filter
The filter object allows you to specify criteria for the report data. You can filter by various dimensions such as call state, direction, type, and more. Each filter consists of a key and an array of values to include in the report.
#### Filter object
| **Key** | **Accepted values** |
| --------------------- | ------------------------------------------------------------------------------- |
| `call_state` | `completed`, `fail`, `busy`, `noanswer`, `canceled` |
| `call_direction` | `inbound`, `outbound` |
| `call_type` | `carrier`, `sip`, `trunking`, `client`, `whatsapp` |
| `twilio_regions` | One or more Twilio regions, for example `us1`, `ie1`, `sg1` |
| `caller_country_code` | ISO alpha-2 country codes for originating callers, for example `US`, `GB`, `IN` |
| `callee_country_code` | ISO alpha-2 country codes for destinations, for example `US`, `GB`, `IN` |
| `silent` | `"true"` or `"false` indicating whether the call was tagged as silent |
## Create Account Report properties
> \[!NOTE]
>
> A Voice Insights Report will be available for 5 days after it is created.
```json
{"type":"object","refName":"insights.v2.create_report_response","modelName":"insights_v2_create_report_response","properties":{"account_sid":{"type":"string","minLength":34,"maxLength":34,"pattern":"^AC[0-9a-fA-F]{32}$","description":"The unique SID identifier of the Account."},"report_id":{"type":"string","description":"The report identifier as Voice Insights Report TTID."},"status":{"type":"string","enum":["created","running","completed"],"description":"The status of the report.","refName":"report_status","modelName":"report_status"},"request_meta":{"type":"object","refName":"report_metadata","modelName":"report_metadata","properties":{"start_time":{"type":"string","format":"date-time","description":"Start time of the report"},"end_time":{"type":"string","format":"date-time","description":"End time of the report"},"filters":{"type":"array","default":[],"description":"Filter values applied to the report","items":{"type":"object","refName":"report_filter","modelName":"report_filter","properties":{"key":{"type":"string","description":"The name of the filter\n'call_state', 'call_direction', 'call_type', 'twilio_regions', 'caller_country_code', 'callee_country_code', 'silent'\n"},"values":{"type":"array","description":"List of supported filter values for the field name","items":{"type":"string"}}}}}}},"url":{"type":"string","format":"uri","nullable":true,"description":"The URL of this resource."}}}
```
## Create a new Account Report
`POST https://insights.twilio.com/v2/Voice/Reports`
### Request body parameters
```json
{"schema":{"type":"object","refName":"insights.v2.create_account_report_request","modelName":"insights_v2_create_account_report_request","properties":{"time_range":{"type":"object","description":"Optional start and end date time for the report window. Defaults to the most recent 7 days when omitted.","properties":{"start_time":{"type":"string","format":"date-time","description":"Start time of the report","example":"2024-01-01T00:00:00Z","x-twilio":{"shortDescription":"Start time of the report"}},"end_time":{"type":"string","format":"date-time","description":"End time of the report","example":"2024-01-07T00:00:00Z","x-twilio":{"shortDescription":"Start time of the report"}}}},"filters":{"type":"array","items":{"type":"object","refName":"report_filter","modelName":"report_filter","properties":{"key":{"type":"string","description":"The name of the filter\n'call_state', 'call_direction', 'call_type', 'twilio_regions', 'caller_country_code', 'callee_country_code', 'silent'\n"},"values":{"type":"array","description":"List of supported filter values for the field name","items":{"type":"string"}}}}}}},"encodingType":"application/json","conditionalParameterMap":{}}
```
The recent 7 days report can be created without any parameters.
Create a new Account Report
```js
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const authToken = process.env.TWILIO_AUTH_TOKEN;
const client = twilio(accountSid, authToken);
async function createAccountReport() {
const report = await client.insights.v2.reports().create();
console.log(report.accountSid);
}
createAccountReport();
```
```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client
from twilio.rest.insights.v2 import AccountReportList
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
auth_token = os.environ["TWILIO_AUTH_TOKEN"]
client = Client(account_sid, auth_token)
report = client.insights.v2.reports().create()
print(report.account_sid)
```
```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install
using System;
using Twilio;
using Twilio.Rest.Insights.V2;
using System.Threading.Tasks;
class Program {
public static async Task Main(string[] args) {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
string authToken = Environment.GetEnvironmentVariable("TWILIO_AUTH_TOKEN");
TwilioClient.Init(accountSid, authToken);
var report = await ReportResource.CreateAsync();
Console.WriteLine(report.AccountSid);
}
}
```
```java
// Install the Java helper library from twilio.com/docs/java/install
import com.twilio.Twilio;
import com.twilio.rest.insights.v2.Report;
public class Example {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");
public static final String AUTH_TOKEN = System.getenv("TWILIO_AUTH_TOKEN");
public static void main(String[] args) {
Twilio.init(ACCOUNT_SID, AUTH_TOKEN);
Report report = Report.creator().create();
System.out.println(report.getAccountSid());
}
}
```
```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main
import (
"fmt"
"github.com/twilio/twilio-go"
insights "github.com/twilio/twilio-go/rest/insights/v2"
"os"
)
func main() {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment
client := twilio.NewRestClient()
params := &insights.CreateAccountReportParams{}
resp, err := client.InsightsV2.CreateAccountReport(params)
if err != nil {
fmt.Println(err.Error())
os.Exit(1)
} else {
fmt.Println(resp.AccountSid)
}
}
```
```php
insights->v2->reports()->create();
print $report->accountSid;
```
```ruby
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'twilio-ruby'
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = ENV['TWILIO_ACCOUNT_SID']
auth_token = ENV['TWILIO_AUTH_TOKEN']
@client = Twilio::REST::Client.new(account_sid, auth_token)
report = @client
.insights
.v2
.reports
.create
puts report.account_sid
```
```bash
# This endpoint is not currently supported by the Twilio CLI. You can open an issue to request it on https://github.com/twilio/twilio-cli/issues
# For an alternative low-code solution, check out https://www.twilio.com/docs/openapi/using-twilio-postman-collections
```
```bash
curl -X POST "https://insights.twilio.com/v2/Voice/Reports" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
```json
{
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av",
"status": "created",
"request_meta": {
"start_time": "2024-11-01T00:00:00Z",
"end_time": "2024-11-07T00:00:00Z",
"filters": []
},
"url": "https://insights.twilio.com/v2/Voice/Reports/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av"
}
```
You can create an account level report with a specific date range by providing the `time_range` parameter.
Create an Account Level Report with Date Time Range
```js
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const authToken = process.env.TWILIO_AUTH_TOKEN;
const client = twilio(accountSid, authToken);
async function createAccountReport() {
const report = await client.insights.v2.reports().create({
time_range: {
start_datetime: "2024-10-15T00:00:00Z",
end_datetime: "2024-11-07T00:00:00Z",
},
});
console.log(report.accountSid);
}
createAccountReport();
```
```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client
from twilio.rest.insights.v2 import AccountReportList
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
auth_token = os.environ["TWILIO_AUTH_TOKEN"]
client = Client(account_sid, auth_token)
report = client.insights.v2.reports().create(
insights_v2_create_account_report_request=AccountReportList.InsightsV2CreateAccountReportRequest(
{
"time_range": AccountReportList.InsightsV2CreateAccountReportRequestTimeRange(
{
"start_datetime": "2024-10-15T00:00:00Z",
"end_datetime": "2024-11-07T00:00:00Z",
}
)
}
)
)
print(report.account_sid)
```
```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install
using System;
using Twilio;
using Twilio.Rest.Insights.V2;
using System.Threading.Tasks;
using System.Collections.Generic;
class Program {
public static async Task Main(string[] args) {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
string authToken = Environment.GetEnvironmentVariable("TWILIO_AUTH_TOKEN");
TwilioClient.Init(accountSid, authToken);
var report = await ReportResource.CreateAsync(
insightsV2CreateAccountReportRequest: new ReportResource
.InsightsV2CreateAccountReportRequest.Builder()
.WithTimeRange(
new ReportResource.InsightsV2CreateAccountReportRequestTimeRange.Builder()
.WithStartDatetime("2024-10-15T00:00:00Z")
.WithEndDatetime("2024-11-07T00:00:00Z")
.Build())
.Build());
Console.WriteLine(report.AccountSid);
}
}
```
```java
// Install the Java helper library from twilio.com/docs/java/install
import java.util.HashMap;
import com.twilio.Twilio;
import com.twilio.rest.insights.v2.Report;
public class Example {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");
public static final String AUTH_TOKEN = System.getenv("TWILIO_AUTH_TOKEN");
public static void main(String[] args) {
Twilio.init(ACCOUNT_SID, AUTH_TOKEN);
Report.InsightsV2CreateAccountReportRequestTimeRange timeRange =
new Report.InsightsV2CreateAccountReportRequestTimeRange();
timeRange.setStartDatetime("2024-10-15T00:00:00Z");
timeRange.setEndDatetime("2024-11-07T00:00:00Z");
Report.InsightsV2CreateAccountReportRequest insightsV2CreateAccountReportRequest =
new Report.InsightsV2CreateAccountReportRequest();
insightsV2CreateAccountReportRequest.setTimeRange(insightsV2CreateAccountReportRequestTimeRange);
Report report = Report.creator(insightsV2CreateAccountReportRequest).create();
System.out.println(report.getAccountSid());
}
}
```
```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main
import (
"fmt"
"github.com/twilio/twilio-go"
insights "github.com/twilio/twilio-go/rest/insights/v2"
"os"
)
func main() {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment
client := twilio.NewRestClient()
params := &insights.CreateAccountReportParams{}
params.SetInsightsV2CreateAccountReportRequest(insights.insights_v2_create_account_report_request{
TimeRange: insights.InsightsV2CreateAccountReportRequestTimeRange{
StartDatetime: "2024-10-15T00:00:00Z",
EndDatetime: "2024-11-07T00:00:00Z",
},
})
resp, err := client.InsightsV2.CreateAccountReport(params)
if err != nil {
fmt.Println(err.Error())
os.Exit(1)
} else {
fmt.Println(resp.AccountSid)
}
}
```
```php
insights->v2->reports()->create(
AccountReportModels::createInsightsV2CreateAccountReportRequest([
"timeRange" => AccountReportModels::createInsightsV2CreateAccountReportRequestTimeRange(
[
"startDatetime" => "2024-10-15T00:00:00Z",
"endDatetime" => "2024-11-07T00:00:00Z",
]
),
])
);
print $report->accountSid;
```
```ruby
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'twilio-ruby'
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = ENV['TWILIO_ACCOUNT_SID']
auth_token = ENV['TWILIO_AUTH_TOKEN']
@client = Twilio::REST::Client.new(account_sid, auth_token)
report = @client
.insights
.v2
.reports
.create(
insights_v2_create_account_report_request: {
'time_range' => {
'start_datetime' => '2024-10-15T00:00:00Z',
'end_datetime' => '2024-11-07T00:00:00Z'
}
}
)
puts report.account_sid
```
```bash
# This endpoint is not currently supported by the Twilio CLI. You can open an issue to request it on https://github.com/twilio/twilio-cli/issues
# For an alternative low-code solution, check out https://www.twilio.com/docs/openapi/using-twilio-postman-collections
```
```bash
INSIGHTS_V2_CREATE_ACCOUNT_REPORT_REQUEST_OBJ=$(cat << EOF
{
"time_range": {
"start_datetime": "2024-10-15T00:00:00Z",
"end_datetime": "2024-11-07T00:00:00Z"
}
}
EOF
)
curl -X POST "https://insights.twilio.com/v2/Voice/Reports" \
--json "$INSIGHTS_V2_CREATE_ACCOUNT_REPORT_REQUEST_OBJ" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
```json
{
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av",
"status": "created",
"request_meta": {
"start_time": "2024-11-01T00:00:00Z",
"end_time": "2024-11-07T00:00:00Z",
"filters": []
},
"url": "https://insights.twilio.com/v2/Voice/Reports/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av"
}
```
You can create an account level report with filters by providing the `filters` parameter.
Create an Account Level Report with Filters
```js
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const authToken = process.env.TWILIO_AUTH_TOKEN;
const client = twilio(accountSid, authToken);
async function createAccountReport() {
const report = await client.insights.v2.reports().create({
time_range: {
start_datetime: "2024-10-15T00:00:00Z",
end_datetime: "2024-11-07T00:00:00Z",
},
filters: [
{
key: "call_type",
values: ["carrier", "client"],
},
{
key: "caller_country_code",
values: ["US"],
},
],
});
console.log(report.accountSid);
}
createAccountReport();
```
```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client
from twilio.rest.insights.v2 import AccountReportList
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
auth_token = os.environ["TWILIO_AUTH_TOKEN"]
client = Client(account_sid, auth_token)
report = client.insights.v2.reports().create(
insights_v2_create_account_report_request=AccountReportList.InsightsV2CreateAccountReportRequest(
{
"time_range": AccountReportList.InsightsV2CreateAccountReportRequestTimeRange(
{
"start_datetime": "2024-10-15T00:00:00Z",
"end_datetime": "2024-11-07T00:00:00Z",
}
),
"filters": [
AccountReportList.ReportFilter(
{"key": "call_type", "values": ["carrier", "client"]}
),
AccountReportList.ReportFilter(
{"key": "caller_country_code", "values": ["US"]}
),
],
}
)
)
print(report.account_sid)
```
```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install
using System;
using Twilio;
using Twilio.Rest.Insights.V2;
using System.Threading.Tasks;
using System.Collections.Generic;
class Program {
public static async Task Main(string[] args) {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
string authToken = Environment.GetEnvironmentVariable("TWILIO_AUTH_TOKEN");
TwilioClient.Init(accountSid, authToken);
var report = await ReportResource.CreateAsync(
insightsV2CreateAccountReportRequest: new ReportResource
.InsightsV2CreateAccountReportRequest.Builder()
.WithTimeRange(
new ReportResource.InsightsV2CreateAccountReportRequestTimeRange.Builder()
.WithStartDatetime("2024-10-15T00:00:00Z")
.WithEndDatetime("2024-11-07T00:00:00Z")
.Build())
.WithFilters(new List {
new ReportResource.ReportFilter.Builder()
.WithKey("call_type")
.WithValues(new List { "carrier", "client" })
.Build(),
new ReportResource.ReportFilter.Builder()
.WithKey("caller_country_code")
.WithValues(new List { "US" })
.Build()
})
.Build());
Console.WriteLine(report.AccountSid);
}
}
```
```java
// Install the Java helper library from twilio.com/docs/java/install
import java.util.Arrays;
import java.util.HashMap;
import com.twilio.Twilio;
import com.twilio.rest.insights.v2.Report;
public class Example {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");
public static final String AUTH_TOKEN = System.getenv("TWILIO_AUTH_TOKEN");
public static void main(String[] args) {
Twilio.init(ACCOUNT_SID, AUTH_TOKEN);
Report.InsightsV2CreateAccountReportRequestTimeRange timeRange =
new Report.InsightsV2CreateAccountReportRequestTimeRange();
timeRange.setStartDatetime("2024-10-15T00:00:00Z");
timeRange.setEndDatetime("2024-11-07T00:00:00Z");
Report.ReportFilter reportFilter1 = new Report.ReportFilter();
reportFilter1.setKey("call_type");
reportFilter1.setValues(Arrays.asList("carrier", "client"));
Report.ReportFilter reportFilter2 = new Report.ReportFilter();
reportFilter2.setKey("caller_country_code");
reportFilter2.setValues(Arrays.asList("US"));
Report.InsightsV2CreateAccountReportRequest insightsV2CreateAccountReportRequest =
new Report.InsightsV2CreateAccountReportRequest();
insightsV2CreateAccountReportRequest.setTimeRange(insightsV2CreateAccountReportRequestTimeRange);
insightsV2CreateAccountReportRequest.setFilters(Arrays.asList(reportFilter1, reportFilter2));
Report report = Report.creator(insightsV2CreateAccountReportRequest).create();
System.out.println(report.getAccountSid());
}
}
```
```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main
import (
"fmt"
"github.com/twilio/twilio-go"
insights "github.com/twilio/twilio-go/rest/insights/v2"
"os"
)
func main() {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment
client := twilio.NewRestClient()
params := &insights.CreateAccountReportParams{}
params.SetInsightsV2CreateAccountReportRequest(insights.insights_v2_create_account_report_request{
TimeRange: insights.InsightsV2CreateAccountReportRequestTimeRange{
StartDatetime: "2024-10-15T00:00:00Z",
EndDatetime: "2024-11-07T00:00:00Z",
},
Filters: []insights.ReportFilter{
insights.ReportFilter{
Key: "call_type",
Values: []string{
"carrier",
"client",
},
},
insights.ReportFilter{
Key: "caller_country_code",
Values: []string{
"US",
},
},
},
})
resp, err := client.InsightsV2.CreateAccountReport(params)
if err != nil {
fmt.Println(err.Error())
os.Exit(1)
} else {
fmt.Println(resp.AccountSid)
}
}
```
```php
insights->v2->reports()->create(
AccountReportModels::createInsightsV2CreateAccountReportRequest([
"timeRange" => AccountReportModels::createInsightsV2CreateAccountReportRequestTimeRange(
[
"startDatetime" => "2024-10-15T00:00:00Z",
"endDatetime" => "2024-11-07T00:00:00Z",
]
),
"filters" => [
AccountReportModels::createReportFilter([
"key" => "call_type",
"values" => ["carrier", "client"],
]),
AccountReportModels::createReportFilter([
"key" => "caller_country_code",
"values" => ["US"],
]),
],
])
);
print $report->accountSid;
```
```ruby
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'twilio-ruby'
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = ENV['TWILIO_ACCOUNT_SID']
auth_token = ENV['TWILIO_AUTH_TOKEN']
@client = Twilio::REST::Client.new(account_sid, auth_token)
report = @client
.insights
.v2
.reports
.create(
insights_v2_create_account_report_request: {
'time_range' => {
'start_datetime' => '2024-10-15T00:00:00Z',
'end_datetime' => '2024-11-07T00:00:00Z'
},
'filters' => [
{
'key' => 'call_type',
'values' => [
'carrier',
'client'
]
},
{
'key' => 'caller_country_code',
'values' => [
'US'
]
}
]
}
)
puts report.account_sid
```
```bash
# This endpoint is not currently supported by the Twilio CLI. You can open an issue to request it on https://github.com/twilio/twilio-cli/issues
# For an alternative low-code solution, check out https://www.twilio.com/docs/openapi/using-twilio-postman-collections
```
```bash
INSIGHTS_V2_CREATE_ACCOUNT_REPORT_REQUEST_OBJ=$(cat << EOF
{
"time_range": {
"start_datetime": "2024-10-15T00:00:00Z",
"end_datetime": "2024-11-07T00:00:00Z"
},
"filters": [
{
"key": "call_type",
"values": [
"carrier",
"client"
]
},
{
"key": "caller_country_code",
"values": [
"US"
]
}
]
}
EOF
)
curl -X POST "https://insights.twilio.com/v2/Voice/Reports" \
--json "$INSIGHTS_V2_CREATE_ACCOUNT_REPORT_REQUEST_OBJ" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
```json
{
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av",
"status": "created",
"request_meta": {
"start_time": "2024-11-01T00:00:00Z",
"end_time": "2024-11-07T00:00:00Z",
"filters": []
},
"url": "https://insights.twilio.com/v2/Voice/Reports/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av"
}
```
## Fetch an Account Report
`GET https://insights.twilio.com/v2/Voice/Reports/{reportId}`
### Path parameters
```json
[{"name":"reportId","in":"path","description":"A unique request id.","schema":{"type":"string"},"required":true}]
```
Fetch an Account Report
```js
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const authToken = process.env.TWILIO_AUTH_TOKEN;
const client = twilio(accountSid, authToken);
async function fetchAccountReport() {
const report = await client.insights.v2
.reports("voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av")
.fetch();
console.log(report.accountSid);
}
fetchAccountReport();
```
```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
auth_token = os.environ["TWILIO_AUTH_TOKEN"]
client = Client(account_sid, auth_token)
report = client.insights.v2.reports(
"voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av"
).fetch()
print(report.account_sid)
```
```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install
using System;
using Twilio;
using Twilio.Rest.Insights.V2;
using System.Threading.Tasks;
class Program {
public static async Task Main(string[] args) {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
string authToken = Environment.GetEnvironmentVariable("TWILIO_AUTH_TOKEN");
TwilioClient.Init(accountSid, authToken);
var report = await ReportResource.FetchAsync(
pathReportId: "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av");
Console.WriteLine(report.AccountSid);
}
}
```
```java
// Install the Java helper library from twilio.com/docs/java/install
import com.twilio.Twilio;
import com.twilio.rest.insights.v2.Report;
public class Example {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");
public static final String AUTH_TOKEN = System.getenv("TWILIO_AUTH_TOKEN");
public static void main(String[] args) {
Twilio.init(ACCOUNT_SID, AUTH_TOKEN);
Report report = Report.fetcher("voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av").fetch();
System.out.println(report.getAccountSid());
}
}
```
```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main
import (
"fmt"
"github.com/twilio/twilio-go"
"os"
)
func main() {
// Find your Account SID and Auth Token at twilio.com/console
// and set the environment variables. See http://twil.io/secure
// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment
client := twilio.NewRestClient()
resp, err := client.InsightsV2.FetchAccountReport("voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av")
if err != nil {
fmt.Println(err.Error())
os.Exit(1)
} else {
fmt.Println(resp.AccountSid)
}
}
```
```php
insights->v2
->reports("voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av")
->fetch();
print $report->accountSid;
```
```ruby
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'twilio-ruby'
# Find your Account SID and Auth Token at twilio.com/console
# and set the environment variables. See http://twil.io/secure
account_sid = ENV['TWILIO_ACCOUNT_SID']
auth_token = ENV['TWILIO_AUTH_TOKEN']
@client = Twilio::REST::Client.new(account_sid, auth_token)
report = @client
.insights
.v2
.reports('voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av')
.fetch
puts report.account_sid
```
```bash
# Install the twilio-cli from https://twil.io/cli
twilio api:insights:v2:voice:reports:fetch \
--report-id voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av
```
```bash
curl -X GET "https://insights.twilio.com/v2/Voice/Reports/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av" \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
```json
{
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"report_id": "voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av",
"status": "completed",
"request_meta": {
"start_time": "2024-11-01T00:00:00Z",
"end_time": "2024-11-07T00:00:00Z",
"filters": []
},
"report": {
"call_deliverability_score": 99.99,
"call_answer_score": 83.4,
"total_calls": 67895,
"call_direction": {
"outbound": 43841,
"inbound": 24054
},
"call_state": {
"completed": 43841,
"fail": 4070,
"busy": 4004,
"noanswer": 15030,
"canceled": 1050
},
"call_type": {
"carrier": 14403,
"sip": 23094,
"trunking": 9884,
"client": 20514,
"whatsapp": 0
},
"aloc": 120.34,
"twilio_edge_location": {
"tokyo": 12,
"sydney": 9,
"dublin": 34,
"ashburn": 67784,
"umatilla": 27,
"frankfurt": 29
},
"caller_country_code": {
"US": 67784,
"NL": 111
},
"callee_country_code": {
"PR": 466,
"US": 67143,
"CA": 286
},
"average_queue_time_ms": 212.49,
"silent_calls_percentage": 18.83,
"network_issues": {
"sdk": {
"ice_failures_percentage": 0,
"high_latency_percentage": 26.08,
"high_packet_loss_percentage": 0.06,
"high_jitter_percentage": 1.88
},
"twilio_gateway": {
"high_latency_percentage": 9.26,
"high_packet_loss_percentage": 0.1,
"high_jitter_percentage": 0
}
},
"KYT": {
"outbound_carrier_calling": {
"unique_calling_numbers": 430,
"unique_called_numbers": 35,
"blocked_calls_by_carrier": [
{
"country": "US",
"carriers": [
{
"carrier": "att",
"total_calls": 1000,
"blocked_calls": 3,
"blocked_calls_percentage": 0.3
},
{
"carrier": "tmobile",
"total_calls": 1000,
"blocked_calls": 0,
"blocked_calls_percentage": 0
},
{
"carrier": "verizon",
"total_calls": 1000,
"blocked_calls": 4,
"blocked_calls_percentage": 0.4
}
]
}
],
"short_duration_calls_percentage": 22.15,
"long_duration_calls_percentage": 18.09,
"potential_robocalls_percentage": 0.11,
"branded_calling": {
"total_branded_calls": 500,
"percent_branded_calls": 25,
"answer_rate": 81,
"human_answer_rate": 75,
"engagement_rate": 60,
"by_use_case": [
{
"use_case": "Marketing",
"enabled_phonenumbers": 50,
"total_calls": 200,
"answer_rate": 85,
"human_answer_rate": 80,
"engagement_rate": 70
},
{
"use_case": "Customer Support",
"enabled_phonenumbers": 30,
"total_calls": 150,
"answer_rate": 78,
"human_answer_rate": 72,
"engagement_rate": 65
}
]
},
"voice_integrity": {
"enabled_calls": 1000,
"enabled_percentage": 1.47,
"calls_per_bundle": [
{
"bundle_sid": "BUxxxxxxxxxxxxxxxxxxxx",
"enabled_phonenumbers": 3,
"total_calls": 100,
"answer_rate": 85,
"human_answer_rate": 80
},
{
"bundle_sid": "BUyyyyyyyyyyyyyyyyyyyy",
"enabled_phonenumbers": 2,
"total_calls": 150,
"answer_rate": 78,
"human_answer_rate": 72
}
]
},
"stir_shaken": {
"call_count": {
"stsh_a": 2,
"stsh_b": 1,
"stsh_c": 1
},
"percentage": {
"stsh_a": 50,
"stsh_b": 25,
"stsh_c": 25
},
"answer_rate": {
"stsh_a": 50,
"stsh_b": 0,
"stsh_c": 100
}
}
}
},
"answering_machine_detection": {
"total_calls": 40841,
"answered_by_human_percentage": 57.07,
"answered_by_machine_percentage": 28.01
}
},
"url": "https://insights.twilio.com/v2/Voice/Reports/voiceinsights_report_01jmzm99cte5rrbbhv8bctd4av"
}
```