Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/analytics/periodic-message-volume-by-role

GET
/api/v1/analytics/periodic-message-volume-by-role
curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/analytics/periodic-message-volume-by-role?granularity=hourly'

Retrieves periodic chat message volume split by contact, agent and support roles.

Parameters

Seção intitulada “Parameters”

Query Parameters

Seção intitulada “Query Parameters”
granularity
required

The granularity of the analytics period.

string
Allowed values: hourly daily weekly monthly

The granularity of the analytics 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.

channelIds
Any of:
Array<string>
responderIds
Any of:
Array<string>

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Periodic message volume by role retrieved successfully.

Media typeapplication/json
Array<object>
object
assistant
required
integer
periodEnd
required
string format: date-time
periodStart
required
string format: date-time
support
required
integer
total
required
integer
user
required
integer
Examplegenerated
[
  {
    "assistant": 1,
    "periodEnd": "2026-04-15T12:00:00Z",
    "periodStart": "2026-04-15T12:00:00Z",
    "support": 1,
    "total": 1,
    "user": 1
  }
]

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"
  }
}