Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/analytics/hourly-profile

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

Retrieves a 24x7 hourly message profile for the selected period.

Parameters

Seção intitulada “Parameters”

Query Parameters

Seção intitulada “Query Parameters”
channelIds
Any of:
Array<string>
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”

Hourly analytics profile retrieved successfully.

Media typeapplication/json
Array<object>
object
assistant
required
integer
hour
required
integer
<= 23
support
required
integer
total
required
integer
user
required
integer
weekday
required
integer
<= 6
Examplegenerated
[
  {
    "assistant": 1,
    "hour": 1,
    "support": 1,
    "total": 1,
    "user": 1,
    "weekday": 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"
  }
}