Skip to main content
GET
/
api
/
v1
/
analytics
/
community-metrics
/
{communityId}
/
members
Query community membership metrics
curl --request GET \
  --url https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/members \
  --header 'Authorization: Bearer <token>'
{
  "granularity": "daily",
  "from": "2024-05-01",
  "to": "2024-05-05",
  "data": [
    {
      "date": "2024-05-01",
      "total_members": 20,
      "new_members": 3,
      "lost_members": 0
    },
    {
      "date": "2024-05-02",
      "total_members": 20,
      "new_members": 0,
      "lost_members": 0
    },
    {
      "date": "2024-05-03",
      "total_members": 50,
      "new_members": 30,
      "lost_members": 0
    },
    {
      "date": "2024-05-04",
      "total_members": 50,
      "new_members": 0,
      "lost_members": 0
    },
    {
      "date": "2024-05-05",
      "total_members": 100,
      "new_members": 50,
      "lost_members": 0
    }
  ]
}

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.

​
granularity
enum<string>

daily (default) or aggregate.

Available options:
daily,
aggregate

Response

Successful membership metrics response

​
granularity
enum<string>
required
Available options:
daily
​
from
string<date>
required
​
to
string<date>
required
​
data
object[]
required