Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

ID of the member to retrieve activity counters for.

memberId

string

import { activityCounters } from 'wix-activity-counters.v2';

async function getActivityCounters(memberId) {
  try {
    const result = await activityCounters.getActivityCounters(memberId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getActivityCounters example

import { activityCounters } from 'wix-activity-counters.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const getActivityCounters = webMethod(
  Permissions.Anyone,
  async (memberId) => {
    try {
      const result = await activityCounters.getActivityCounters(memberId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getActivityCounters example for exporting from backend code

getActivityCounters

GetActivityCountersResponse

Returns up to 100 activity counters for the provided filter and paging.

Service will return only counters that are marked as public, or private counters from apps created by the requesting third party.

Supported fields for filtering:
- memberId

Supported operations:
Comparison:
- $eq
- $ne
- $in
Logical:
- $and
- $not
- $or


|PROPERTY	|SUPPORTED FILTERS & SORTING	
|:---:|:---:|
|`memberId`|[`eq()`](/activity-counters/activity-counters-query-builder/eq),[`ne()`](/activity-counters/activity-counters-query-builder/ne),[`in()`](/activity-counters/activity-counters-query-builder/in)|

import { activityCounters } from 'wix-activity-counters.v2';

async function queryActivityCounters() {
  const { items } = activityCounters.queryActivityCounters().find();
}


queryActivityCounters example

import { activityCounters } from 'wix-activity-counters.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const queryActivityCounters = webMethod(
  Permissions.Anyone,
  async (options) => {
    try {
      const result = await activityCounters.queryActivityCounters(options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


queryActivityCounters example for exporting from backend code

queryActivityCounters

ActivityCountersQueryBuilder

ID of the member to upsert an activity counter for.

counter

Counter

Sets activity counters for a member.

If a counter doesn't exist, it's created.

Counters are set under a custom key, which is an ID for the counter, and is unique per app.

import { activityCounters } from 'wix-activity-counters.v2';

async function setActivityCounters(memberId, counter) {
  try {
    const result = await activityCounters.setActivityCounters(memberId, counter);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


setActivityCounters example for dashboard page code

import { activityCounters } from 'wix-activity-counters.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedSetActivityCounters = elevate(activityCounters.setActivityCounters);

export const setActivityCounters = webMethod(
  Permissions.Anyone,
  async (memberId, counter) => {
    try {
      const result = await elevatedSetActivityCounters(memberId, counter);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


setActivityCounters example for exporting from backend code

setActivityCounters

SetActivityCountersResponse

---
title: Introduction
---

# Introduction

&nbsp;

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>

&nbsp;

> __Note__: This module is [universal](https://dev.wix.com/docs/velo/articles/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise.

The Activity Counters module allows you to keep track of site members' activity. See "Integrations" below for Wix App activities that are already counted.

The service allows public and private counters:
 - Public counters can be read by any site member.
 - Private counters can only be accessed by the site member who owns the counter.

The Activity Counters API gives you access to the counters on a site at a per-member, per-app level.

Counters are only activated when a site member actually performs the activity the counter tracks.

This means that the query and list endpoints for this API may return a large number of results, for sites with many members.

## Integrations

Activity Counters is currently integrated with these Wix apps and features:

### Wix Blog

Wix Blog counts blog posts, comments, and likes.

 - [Blog (API documentation)](https://dev.wix.com/api/rest/wix-blog/blog/introduction)

### Wix Forum

Wix Forum counts forum posts, comments, likes, and views.
 - [About Wix Forum](https://support.wix.com/en/article/wix-forum-about-wix-forum)

### Wix Members Area

Wix Members Area counts followers in both directions (followed by / following).
 - [Followers (Members Area feature)](https://support.wix.com/en/article/about-the-members-area)

## Access

Third-party developers can
 - read (but not set) public counts from any apps.
 - read **and** set all counts for their own apps.

## Initializing a counter

To create a new counter for an app, use the [Set Activity Counters function](https://www.wix.com/velo/reference/wix-activity-counters-v2/activitycounters/setactivitycounters).

## Use cases

**Most active writer widget.** 
You want to add a "most active writer" widget to your home page, based on the number of posts each member creates.

1. Get per-member post numbers for blog or forum app using the [Get Activity Counters function](https://www.wix.com/velo/reference/wix-activity-counters-v2/activitycounters/getactivitycounters).
2. Process counts and display in widget.
 
**Most influential member widget.** 
You wants to add a "most influential members" widget to your community, based on how many likes and comments each member's posts gets.

1. Get per-member reaction numbers for blog/forum app using [Get Activity Counters function](https://www.wix.com/velo/reference/wix-activity-counters-v2/activitycounters/getactivitycounters).
2. Process counts and display in widget.

## Import statement

To use Wix Marketing Tags,
import `{ activityCounters }` from the `wix-activity-counters.v2` module:

```js
import { activityCounters } from 'wix-activity-counters.v2';
```

ActivityCountersQueryResult

velo-deps_wix-activity-counters.v2_activity-counters

ActivityCounter

appId

counters

revision

Refines a query to match items where the specified property equals the specified value.

The `eq()` function refines a `ActivityCountersQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.
`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
Matching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Returns the query results.

The `find()` function returns a Promise that resolves to the query results and metadata.
The Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.

find

Refines a query to only match items where the specified property conatins any of the values in the provided array of values.

The `in()` function refines a `ActivityCountersQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.
Matching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Limits the number of items the query returns.

The `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.
You can use the `next()` and `prev()` functions to navigate the pages of a query result.

limit

Refines a query to match items where the specified property doesn't equal the specified value.

The `ne()` function refines a `ActivityCountersQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.
`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
Matching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Sets the number of items to skip before returning query results.

The `skip()` function defines the number of results to skip before returning new query results.
For example, if you query a collection and 50 items match your query, but you set `skip()` to `10`, the first 10 items that match are ignored, and the 11th through 50th items are returned.

skip

Indicates whether the query has more results.

You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.

hasNext

boolean

Indicates whether the query has previous results.

You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.

hasPrev

Retrieves the next page of query results.

The `next()` function retrieves the next page of query results.
The page size is defined by the [`limit()`](wix-activity-counters-v2.ActivityCounters.ActivityCountersQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.
If items are added or removed between calls to `next()`, the values returned by `ActivityCountersQueryBuilder` may change.

Retrieves the previous page of query results.

The `prev()` function retrieves the previous page of query results.
The page size is defined by the [`limit()`](wix-activity-counters-v2.ActivityCounters.ActivityCountersQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.
If items are added or removed between calls to `prev()`, the values returned may change.

Returns the index of the current page of results.

`currentPage` is a zero-based index of the current page of results, meaning the 1st page is `0`, the 2nd page is `1`, and so on.
If no results match the query, `currentPage` is undefined.
The page size is defined by the [`limit()`](wix-activity-counters-v2.ActivityCounters.ActivityCountersQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.

currentPage

number

Returns an array of `activityCounters` items that match the query.

`items` contains the current page of results retrieved by the query.
If no results match the query, `items` is an empty array.
The page size is defined by the [`limit()`](wix-activity-counters-v2.ActivityCounters.ActivityCountersQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.

items

Returns the number of items in the current page of results.

`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).
The page size is defined by the [`limit()`](wix-activity-counters-v2.ActivityCounters.ActivityCountersQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.

length

Returns the requested page size.

`pageSize` returns the page size set in [`limit()`](wix-activity-counters-v2.ActivityCounters.ActivityCountersQueryBuilder#limit) in `ActivityCountersQueryBuilder`.

pageSize

Returns the `ActivityCountersQueryBuilder` object used to get the current results.

Use `query` to create and run a new query by chaining additional `ActivityCountersQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `ActivityCountersQueryBuilder`.

query

Returns the total number of items that match the query.

`totalCount` returns the total number of items that match the query, not just the number of items in the current page. For the number of items in the current page, see [`length`](#length).

totalCount

Returns the total number of pages the query produced.

The page size is defined by the [`limit()`](wix-activity-counters-v2.ActivityCounters.ActivityCountersQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `activityCounters` to navigate the pages of a query result.

totalPages

count

Key of the counter. Must be unique within a given app.

Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app that created the counter).

setActivityCounters( )

Permission Scopes