Skip to main content
GET
/
api
/
v1
/
analytics
/
community-metrics
/
{communityId}
/
most-active-time
Community Hourly engagement
curl --request GET \
  --url https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-time \
  --header 'Authorization: Bearer <token>'
{
  "from": "2024-05-01",
  "to": "2024-05-07",
  "most_active_times": [
    {
      "hour": 0,
      "hour_display": "12:00 AM",
      "sum_engagements": 0,
      "avg_engagements": 0
    },
    {
      "hour": 9,
      "hour_display": "9:00 AM",
      "sum_engagements": 15,
      "avg_engagements": 5
    },
    {
      "hour": 20,
      "hour_display": "8:00 PM",
      "sum_engagements": 10,
      "avg_engagements": 5
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
communityId
string
required

Community ID

Query Parameters

​
from
string<date>

Inclusive start date (YYYY-MM-DD). Defaults to 7 days before yesterday.

​
to
string<date>

Inclusive end date (YYYY-MM-DD). Defaults to yesterday.

Response

Successful most active time response

​
from
string<date>
required
​
to
string<date>
required
​
most_active_times
object[]
required