Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Introduction

The Activity Counters service allows site owners and third-party developers to keep track of Wix 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 third-party developers 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 a third-party app, use the [Set Activity Counters
 endpoint.](https://dev.wix.com/api/rest/members/activity-counters/set-activity-counters)

## Use cases

**Most active writer widget.** 
A developer wants to add a "most active writer" widget to their 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 endpoint.](https://dev.wix.com/api/rest/members/activity-counters/get-activity-counters)
2. Process counts and display in widget.
 
**Most influential member widget.** 
A developer wants to add a "most influential members" widget to his community, based on how many likes and comments each member's posts get.

1. Get per-member reaction numbers for blog/forum app using [Get Activity Counters endpoint.](https://dev.wix.com/api/rest/members/activity-counters/get-activity-counters)
2. Process counts and display in widget.


appId

counters

memberId

ActivityCounter

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).

public

Counter

GetActivityCountersRequest

activityCounters

GetActivityCountersResponse

Site member ID whose counter will be increment.

IncrementActivityCountersRequest

IncrementActivityCountersResponse

filter

Query

QueryActivityCountersRequest

QueryActivityCountersResponse

Site member ID whose counter will be set.

SetActivityCountersRequest

SetActivityCountersResponse

value

BoolValue

Empty

Int32Value

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

limit

Number of items to skip in the current sort order.

offset

Paging

Number of items returned in the response.

Flag that indicates the server failed to calculate the `total` field.

tooManyToCount

Total number of items that match the query.

total

PagingMetadata

bodyAsJson

ActionEvent

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

Assuming that all messages including Actions have id
Example: The id of the specific order, the id of a specific campaign

entityId

The time of the event. Useful if there was a delay in dispatching

eventTime

random GUID so clients can tell if event was already handled

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

A field that should be set if this event was triggered by an anonymize request.
For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.

triggeredByAnonymizeRequest

DomainEvent

body

entityAsJson

EntityCreatedEvent

EntityDeletedEvent

Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.

currentEntityAsJson

EntityUpdatedEvent

Sets activity counters for a requested site member.

If a counter does not yet exist, it will be created.

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

Manage Activity Counters

SetActivityCounters

Set activity counter event

This event happens after updating a counter.

Activity Counter Updated

Returns activity counters for a requested site member.
A third party can read all the public counters, set by any apps. However, third parties can only read their own private counters, not those from others' apps.

Read Activity Counters

GetActivityCounters

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

Set Activity Counters

Permission Scopes