members_count (records)

Required permit	Rate limit tokens cost
Reporting:Api:Report:MembersCount	1

This report allows you to get information about total member count in your loyalty clubs (community).

Counts are always grouped by ID of community.

Fields

community_id

Type	Filterable	Readonly
Integer	(via `X-Customer` header)

ID of community.

members_count

Type	Filterable	Readonly
Integer

Count of members.

updated_at

Type	Filterable	Readonly
Time

Time when last change of members_count was done.

Note that it may be not the same as last time of member's update.

Query without aggregations

Query returns list of member counts.

{
    "records": [
        {
            "community_id": 235,
            "members_count": 850,
            "updated_at": "2024-08-14T05:56:40.098000Z"
        }
    ],
    "pagination": {
        "next_page_info": null
    },
    "result_type": "records"
}

Aggregations

total

Returns total member count in context of all communities.

Example query response

{
    "records": [
        {
            "members_count": 850,
        }
    ],
    "pagination": {
        "next_page_info": null
    },
    "result_type": "records"
}

Fields#

community_id#

members_count#

updated_at#

Query without aggregations#

Aggregations#

total#

Example query response#