Get conversation analytics

POST/v1/channels/{channelID}/analytics/conversations

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

channelIDstringrequired

Channel ID

Request body

requiredapplication/json

conversation_categoriesstring[] | null

Conversation categories

conversation_directionsstring[] | null

Conversation directions

conversation_typesstring[] | null

Conversation types

dimensionsstring[] | null

Dimensions for breakdown

endinteger<int64>required

End timestamp (Unix epoch)

granularitystringrequired

Data granularity

Allowed:DAYHOURHALF_HOUR

metric_typesstring[] | null

Metric types (COST, CONVERSATION)

phone_numbersstring[] | null

Filter by phone numbers

startinteger<int64>required

Start timestamp (Unix epoch)

Responses

200OK

dataConversationAnalyticsData[] | null

Show properties

Array of ConversationAnalyticsData

data_pointsAnalyticsDataPoint[] | null

Show properties

Array of AnalyticsDataPoint

conversationinteger<int64>

conversation_categorystring

conversation_directionstring

conversation_typestring

costnumber<double>

countrystring

deliveredinteger<int64>

endinteger<int64>

phone_numberstring

pricing_categorystring

pricing_typestring

sentinteger<int64>

startinteger<int64>

volumeinteger<int64>

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/channels/string/analytics/conversations" \
  -H "Content-Type: application/json" \
  -d '{
  "conversation_categories": [
    "string"
  ],
  "conversation_directions": [
    "string"
  ],
  "conversation_types": [
    "string"
  ],
  "dimensions": [
    "string"
  ],
  "end": 0,
  "granularity": "DAY",
  "metric_types": [
    "string"
  ],
  "phone_numbers": [
    "string"
  ],
  "start": 0
}'

const response = await fetch("/v1/channels/string/analytics/conversations", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "conversation_categories": [
    "string"
  ],
  "conversation_directions": [
    "string"
  ],
  "conversation_types": [
    "string"
  ],
  "dimensions": [
    "string"
  ],
  "end": 0,
  "granularity": "DAY",
  "metric_types": [
    "string"
  ],
  "phone_numbers": [
    "string"
  ],
  "start": 0
})
});

import requests

response = requests.post(
    "/v1/channels/string/analytics/conversations",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "conversation_categories": [
    "string"
  ],
  "conversation_directions": [
    "string"
  ],
  "conversation_types": [
    "string"
  ],
  "dimensions": [
    "string"
  ],
  "end": 0,
  "granularity": "DAY",
  "metric_types": [
    "string"
  ],
  "phone_numbers": [
    "string"
  ],
  "start": 0
},
)

Response

{
  "data": [
    {
      "data_points": [
        {
          "conversation": 0,
          "conversation_category": "string",
          "conversation_direction": "string",
          "conversation_type": "string",
          "cost": 0,
          "country": "string",
          "delivered": 0,
          "end": 0,
          "phone_number": "string",
          "pricing_category": "string",
          "pricing_type": "string",
          "sent": 0,
          "start": 0,
          "volume": 0
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}