---
"@context": https://schema.org
"@type": TechArticle
"@id": https://www.twilio.com/docs/api/insights#article
headline: Insights API (v3)
description: Overview of Twilio's Insights API (v3)
url: https://www.twilio.com/docs/api/insights
inLanguage: en
author:
  "@type": Organization
  name: Twilio Developer Education Team
publisher:
  "@type": Organization
  name: Twilio
---

# Insights API (v3)

> \[!IMPORTANT]
>
> Conversation Insights, including the APIs, is currently available as a public beta release and the information contained in this document is subject to change. Some features are not yet implemented and others may be changed before the product is declared as generally available. Public beta products are not covered by the Twilio Support Terms or Twilio Service Level Agreement.
>
> Conversation Insights is not PCI compliant or a HIPAA Eligible Service and should not be used in workflows that are subject to HIPAA or PCI.
>
> Conversations products are only available in the [new Twilio Console](https://1console.twilio.com). If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

The Twilio Insights v3 API provides semantic query access to Conversations
analytics data. Resources include synchronous Query, Metadata, and asynchronous
QueryJobs for long-running queries.

## Base URL

`https://insights.twilio.com`

## Security

**Basic Auth**

This API uses [basic authentication](https://www.twilio.com/docs/glossary/what-is-basic-authentication). Use an [API key](https://www.twilio.com/docs/iam/api-keys) as the username and the API key secret as the password. You can also use your account SID and auth token, but limit their use to local testing.

Example: `Authorization: Basic ZGVtbzpwQDU1dzByZA==`

## Resources

* [Twilio Insights](/docs/api/insights/twilio-insights)

  * [Retrieve domain metadata](/docs/api/insights/twilio-insights/fetch-metadata)
  * [Execute a synchronous semantic query](/docs/api/insights/twilio-insights/create-query-results)
  * [Retrieve paginated query results](/docs/api/insights/twilio-insights/fetch-query-results)
* [Twilio Insights Async](/docs/api/insights/twilio-insights-async)

  * [Submit an asynchronous query](/docs/api/insights/twilio-insights-async/create-query-job)
  * [Retrieve a list of asynchronous queries](/docs/api/insights/twilio-insights-async/list-query-jobs)
  * [Retrieve asynchronous query status and results](/docs/api/insights/twilio-insights-async/fetch-query-job-status)
  * [Retrieve asynchronous query results](/docs/api/insights/twilio-insights-async/fetch-query-job-results)
* [Twilio Insights Config](/docs/api/insights/twilio-insights-config)

  * [Register a custom measure field mapping](/docs/api/insights/twilio-insights-config/create-custom-field-mapping)
  * [List custom measure field mappings for an account](/docs/api/insights/twilio-insights-config/list-custom-field-mappings)
  * [Fetch a custom field mapping](/docs/api/insights/twilio-insights-config/fetch-custom-field-mapping)
  * [Update a custom field mapping](/docs/api/insights/twilio-insights-config/patch-custom-field-mapping)
  * [Get custom field mapping capacity for an account](/docs/api/insights/twilio-insights-config/fetch-custom-field-mapping-capacity)

## Additional information

[Contact Twilio Support](https://support.twilio.com)

License: [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)

[Terms of Service](https://www.twilio.com/legal/tos)