Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/analytics/overview

GET
/api/v1/analytics/overview
curl --request GET \
  --url https://api.endless.zaia.app/api/v1/analytics/overview

Retrieves analytics overview KPIs for the selected period and the previous period of equal duration.

Parameters

Seção intitulada “Parameters”

Query Parameters

Seção intitulada “Query Parameters”
channelIds
Any of:
Array<string>
compareRangeEnd

The end date of the comparison period.

string format: date-time
nullable

The end date of the comparison period.

compareRangeStart

The start date of the comparison period.

string format: date-time
nullable

The start date of the comparison period.

rangeEnd

The end date of the analytics period.

string format: date-time
nullable

The end date of the analytics period.

rangeStart

The start date of the analytics period.

string format: date-time
nullable

The start date of the analytics period.

responderIds
Any of:
Array<string>

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Analytics overview retrieved successfully.

Media typeapplication/json
object
current
required
object
assistantMessages
required
integer
avgAgentPerConversation
required
number
avgMessagesPerUser
required
number
byChannelType
required
Array<object>
object
assistantMessages
required
integer
channelId
required
string
channelName
required
string
channelType
required
string
Allowed values: api widget widget-test waha whatsapp instagram telegram
conversations
required
integer
humanInterventions
required
integer
supportMessages
required
integer
totalMessages
required
integer
uniqueUsers
required
integer
userMessages
required
integer
conversations
required
integer
humanInterventions
required
integer
recurringUsers
required
integer
supportMessages
required
integer
totalMessages
required
integer
uniqueUsers
required
integer
userMessages
required
integer
previous
required
object
assistantMessages
required
integer
avgAgentPerConversation
required
number
avgMessagesPerUser
required
number
byChannelType
required
Array<object>
object
assistantMessages
required
integer
channelId
required
string
channelName
required
string
channelType
required
string
Allowed values: api widget widget-test waha whatsapp instagram telegram
conversations
required
integer
humanInterventions
required
integer
supportMessages
required
integer
totalMessages
required
integer
uniqueUsers
required
integer
userMessages
required
integer
conversations
required
integer
humanInterventions
required
integer
recurringUsers
required
integer
supportMessages
required
integer
totalMessages
required
integer
uniqueUsers
required
integer
userMessages
required
integer
Example
{
  "current": {
    "byChannelType": [
      {
        "channelType": "api"
      }
    ]
  },
  "previous": {
    "byChannelType": [
      {
        "channelType": "api"
      }
    ]
  }
}

401

Seção intitulada “401”

Unauthorized.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}