Twilio

Twilio Insights v3

The Twilio Insights v3 API provides semantic query access to Conversations analytics data. Resources include synchronous Query, Metadata, and asynchronous…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 12

TwilioInsights

  • GETRetrieve paginated query results/v3/InsightsDomains/Conversations/Query?pageToken=eyJwYWdlIjoyLCJxdWVyeSI6ImJvb2tzIn0=Retrieve subsequent pages of a synchronous query using a page token.
  • POSTExecute a synchronous semantic query/v3/InsightsDomains/Conversations/Query?pageSize=20Execute a semantic query against the Conversations domain. Returns results inline. For long-running queries, use the QueryJobs endpoint.
  • GETRetrieve domain metadata/v3/InsightsDomains/Conversations/MetadataReturns available cubes, measures, and dimensions for the Conversations domain.

TwilioInsightsAsync

  • GETRetrieve a list of asynchronous queries/v3/InsightsDomains/Conversations/QueryJobs?pageSize=50&pageToken=string&status=PENDINGReturns a paginated list of asynchronous query operations for the authenticated account. Optionally filter by status.
  • POSTSubmit an asynchronous query/v3/InsightsDomains/Conversations/QueryJobsSubmit a long-running semantic query against the Conversations domain. Returns 202 Accepted with an operationId and a Location header pointing to the…
  • GETRetrieve asynchronous query status and results/v3/InsightsDomains/Conversations/QueryJobs/:operationIdPoll the operation status. When status is COMPLETED, the response includes query results inline. When FAILED, the response includes error details conforming…
  • GETRetrieve asynchronous query results/v3/InsightsDomains/Conversations/QueryJobs/:operationId/Results?pageSize=50&pageToken=stringRetrieve paginated results for a completed asynchronous query operation. The resultUrl in the status response points to this endpoint. Returns 404 if the…

TwilioInsightsConfig

  • GETList custom measure field mappings for an account/v3/ControlPlane/ConversationInsights/CustomFieldMappings?pageSize=50&pageToken=stringReturns the custom field mappings registered for the account, one page at a time. Use pageSize to limit the number of mappings returned, and pass…
  • POSTRegister a custom measure field mapping/v3/ControlPlane/ConversationInsights/CustomFieldMappingsRegisters a custom field for the account. entityMetadata.sourceType selects where the field's value comes from, and the matching property on entityMetadata…
  • GETFetch a custom field mapping/v3/ControlPlane/ConversationInsights/CustomFieldMappings/:mappingIdReturns a single custom field mapping by its mappingId. The ETag response header identifies the mapping's current version; supply it as If-Match on PATCH to…
  • PATCHUpdate a custom field mapping/v3/ControlPlane/ConversationInsights/CustomFieldMappings/:mappingIdPartially updates an existing custom field mapping. Only the properties present in the body are changed. The updatable properties depend on the mapping's…
  • GETGet custom field mapping capacity for an account/v3/ControlPlane/ConversationInsights/CustomFieldMappingsCapacityReturns the account's custom measure slot capacity — slots consumed and remaining. Only the measure category is supported for now.

API details

Base URL
https://insights.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
12 operations on 8 pathsGET 8POST 3PATCH 1
Main resources
TwilioInsightsConfig 5TwilioInsightsAsync 4TwilioInsights 3
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.1.0

How to test the Twilio Insights v3 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Insights v3 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve paginated query results” (GET /v3/InsightsDomains/Conversations/Query?pageToken=eyJwYWdlIjoyLCJxdWVyeSI6ImJvb2tzIn0=), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio Insights v3?

The Twilio Insights v3 API provides semantic query access to Conversations analytics data. Resources include synchronous Query, Metadata, and asynchronous… It is listed under Communication and has 12 endpoints.

Who publishes the Twilio Insights v3?

It is listed from Twilio's public API description (an OpenAPI document), not published by Twilio on Swastik Codes. Anyone who controls twilio.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio Insights v3?

Requests go to https://insights.twilio.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio Insights v3?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Insights v3 have?

12 operations on 8 paths (8 GET, 3 POST, 1 PATCH). The largest groups are TwilioInsightsConfig, TwilioInsightsAsync, TwilioInsights.

Is forking the Twilio Insights v3 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.