Skip to main content
GET
/
metrics
/
{year}
/
{month}
Metric by month. Metrics are retained for 180 days.
curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/metrics/{year}/{month} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "year": 123,
    "month": 123,
    "customer_messages_count": 123,
    "new_customers_count": 123,
    "existing_customers_count": 123,
    "fresh_conversations_count": 123,
    "agent_messages_count": 123,
    "average_agent_response_time_minutes": 123,
    "marketing_opt_in_profiles_count": 123,
    "marketing_opt_out_profiles_count": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
year
integer
required
​
month
integer
required

Response

200 - application/json

Success

​
data
object

Collected metrics on a monthly basis.