{"id":"211d1c6b-a7bb-40a4-a576-17316a267af9","createdDate":"2024-12-30T10:18:08.418Z","updatedDate":"2024-12-30T10:18:08.418Z","resourceId":"78625e9e-72c0-4fb0-a41f-12eb7e1454f1","api":{"schema":{"object":{"displayName":"Activity Counter Object","description":"Activity Counters service APIs","slug":"activity-counter-object","$ref":"#/components/schemas/com.wixpress.members.activitycounters.ActivityCounter","legacyExamples":[{"title":"ActivityCounter","content":"{\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is key\",\n \"public\": true,\n \"count\": 1\n }\n ]\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"Set Activity Counters","description":"Sets activity counters for a requested site member.\n\nIf a counter does not yet exist, it will be created.\n\nCounters are set under a custom key, which is an ID for the counter, and is unique.\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.members.activitycounters.ActivityCounters.SetActivityCounters","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"memberId","description":"","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.members.activitycounters.SetActivityCountersResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SetActivityCountersRequest","description":"","properties":{"counter":{"description":"Site member ID whose counter will be set.","$ref":"#/components/schemas/com.wixpress.members.activitycounters.Counter","summary":"counter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["counter","memberId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Activity Counter Updated","description":"Triggered when an activity counter is updated.","permissions":["MEMBERS.ACTIVITY_COUNTERS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.members.v1.activity_counter","serviceName":"com.wixpress.members.activitycounters.ActivityCounters","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.members.v1.activity_counter_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.members.activitycounters.ActivityCounters","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MEMBERS.ACTIVITY_COUNTERS_WRITE"],"protoArtifactId":"com.wixpress.members:activity-counters-api","serviceArtifactId":"com.wixpress.members.activity-counters-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.members.activitycounters.SetActivityCountersRequest","responseMessage":"com.wixpress.members.activitycounters.SetActivityCountersResponse"},"legacyExamples":[{"name":"SetActivityCounters","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PUT \\\n https://www.wixapis.com/members/v1/activity-counters/bc93bbe5-228e-4468-a9ac-ebc15f90427e \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"counter\": {\n \"key\": \"My custom key\",\n \"public\": true,\n \"count\": 10\n }\n }'\n~~~","response":"~~~json\n{\n \"activityCounter\": {\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is my public key\",\n \"public\": true,\n \"count\": 1\n },\n {\n \"key\": \"My custom key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"put","path":"/v1/activity-counters/{memberId}","rpcOnly":false,"servers":[{"url":"https://www.wixapis.com/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"www.wixapis.com","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://_/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://manage.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"manage._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://www.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"www._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://*.dev.wix-code.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"*.dev.wix-code.com","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://editor.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"editor._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://blocks.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"blocks._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://create.editorx/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"create.editorx","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}}],"triggeredEvents":[{"title":"Activity Counter Updated","description":"Triggered when an activity counter is updated.","permissions":["MEMBERS.ACTIVITY_COUNTERS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.members.v1.activity_counter","serviceName":"com.wixpress.members.activitycounters.ActivityCounters","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.members.v1.activity_counter_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.members.activitycounters.ActivityCounters","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MEMBERS.ACTIVITY_COUNTERS_WRITE"],"protoArtifactId":"com.wixpress.members:activity-counters-api","serviceArtifactId":"com.wixpress.members.activity-counters-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.members.activitycounters.SetActivityCountersRequest","responseMessage":"com.wixpress.members.activitycounters.SetActivityCountersResponse"},"legacyExamples":[{"name":"SetActivityCounters","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PUT \\\n https://www.wixapis.com/members/v1/activity-counters/bc93bbe5-228e-4468-a9ac-ebc15f90427e \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"counter\": {\n \"key\": \"My custom key\",\n \"public\": true,\n \"count\": 10\n }\n }'\n~~~","response":"~~~json\n{\n \"activityCounter\": {\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is my public key\",\n \"public\": true,\n \"count\": 1\n },\n {\n \"key\": \"My custom key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Set Activity Counters","slugifiedName":"set-activity-counters"},"permissionScopes":[{"name":"Manage Activity Counters","scopeId":"SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS"}],"isAdminMethod":true},{"summary":"Get Activity Counters","description":"Returns activity counters for a requested site member.\nA third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.members.activitycounters.ActivityCounters.GetActivityCounters","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"memberId","description":"","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.members.activitycounters.GetActivityCountersResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.members.activitycounters.ActivityCounters","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MEMBERS.ACTIVITY_COUNTERS_READ"],"protoArtifactId":"com.wixpress.members:activity-counters-api","serviceArtifactId":"com.wixpress.members.activity-counters-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.members.activitycounters.GetActivityCountersRequest","responseMessage":"com.wixpress.members.activitycounters.GetActivityCountersResponse"},"legacyExamples":[{"name":"GetActivityCounters","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/members/v1/activity-counters/987110f7-5100-4beb-a948-de610fd18f00 \\\n -H 'Authorization: ' \\\n~~~","response":"~~~json\n{\n \"activityCounters\": [\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is public key\",\n \"public\": true,\n \"count\": 3\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is private key\",\n \"public\": false,\n \"count\": 10\n },\n {\n \"key\": \"This is another public key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/activity-counters/{memberId}","rpcOnly":false,"servers":[{"url":"https://www.wixapis.com/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"www.wixapis.com","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://_/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://manage.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"manage._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://www.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"www._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://*.dev.wix-code.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"*.dev.wix-code.com","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://editor.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"editor._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://blocks.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"blocks._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://create.editorx/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"create.editorx","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}}],"triggeredEvents":[],"serviceName":"com.wixpress.members.activitycounters.ActivityCounters","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MEMBERS.ACTIVITY_COUNTERS_READ"],"protoArtifactId":"com.wixpress.members:activity-counters-api","serviceArtifactId":"com.wixpress.members.activity-counters-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.members.activitycounters.GetActivityCountersRequest","responseMessage":"com.wixpress.members.activitycounters.GetActivityCountersResponse"},"legacyExamples":[{"name":"GetActivityCounters","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://www.wixapis.com/members/v1/activity-counters/987110f7-5100-4beb-a948-de610fd18f00 \\\n -H 'Authorization: ' \\\n~~~","response":"~~~json\n{\n \"activityCounters\": [\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is public key\",\n \"public\": true,\n \"count\": 3\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is private key\",\n \"public\": false,\n \"count\": 10\n },\n {\n \"key\": \"This is another public key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Activity Counters","slugifiedName":"get-activity-counters"},"permissionScopes":[{"name":"Manage Activity Counters","scopeId":"SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS"},{"name":"Read Activity Counters","scopeId":"SCOPE.DC-MEMBERS.READ-ACTIVITY-COUNTERS"}],"isAdminMethod":false},{"summary":"Query Activity Counters","description":"Returns up to 100 activity counters for the provided filter and paging.\n\nService will return only counters that are marked as public, or private counters from apps created by the requesting third party.\n\nSupported fields for filtering:\n- memberId\n\nSupported operations:\nComparison:\n- $eq\n- $ne\n- $in\nLogical:\n- $and\n- $not\n- $or","operationId":"com.wixpress.members.activitycounters.ActivityCounters.QueryActivityCounters","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.members.activitycounters.QueryActivityCountersResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryActivityCountersRequest","description":"","properties":{"query":{"description":"","$ref":"#/components/schemas/com.wixpress.members.activitycounters.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.members.activitycounters.ActivityCounters","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MEMBERS.ACTIVITY_COUNTERS_READ"],"protoArtifactId":"com.wixpress.members:activity-counters-api","serviceArtifactId":"com.wixpress.members.activity-counters-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.members.activitycounters.QueryActivityCountersRequest","responseMessage":"com.wixpress.members.activitycounters.QueryActivityCountersResponse"},"legacyExamples":[{"name":"QueryActivityCounters","type":"METHOD","order":1,"content":{"title":"Query activity counters","description":"Retrieving counters with member id","request":"curl -X POST \\\n https://www.wixapis.com/members/v1/activity-counters/query \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\"\n }\n }\n }'","response":"{\n \"activityCounters\": [\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is public key\",\n \"public\": true,\n \"count\": 3\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is another public key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"QueryActivityCounters","type":"METHOD","content":{"title":"Query activity counters","description":"Retrieving counters with empty filter","request":"curl -X POST \\\n https://www.wixapis.com/members/v1/activity-counters/query \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {}\n }\n }'","response":"{\n \"activityCounters\": [\n {\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is my public key\",\n \"public\": true,\n \"count\": 1\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is public key\",\n \"public\": true,\n \"count\": 3\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is another public key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n ],\n \"metadata\": {\n \"count\": 3,\n \"offset\": 0,\n \"total\": 3\n }\n}"}},{"name":"QueryActivityCounters","type":"METHOD","order":2,"content":{"title":"Query activity counters","description":"Retrieving counters with two member ids and limit one","request":"curl -X POST \\\n https://www.wixapis.com/members/v1/activity-counters/query \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\n \"memberId\": {\n \"$in\": [\n \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\"\n ]\n }\n },\n \"paging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"activityCounters\": [\n {\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is my public key\",\n \"public\": true,\n \"count\": 1\n }\n ]\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/activity-counters/query","rpcOnly":false,"servers":[{"url":"https://www.wixapis.com/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"www.wixapis.com","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://_/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://manage.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"manage._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://www.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"www._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://*.dev.wix-code.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"*.dev.wix-code.com","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://editor.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"editor._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://blocks.wix.com/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"blocks._base_domain_","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}},{"url":"https://create.editorx/_api/members/v1/activity-counters","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/members/v1/activity-counters","destinationPath":"/v1/activity-counters","url":"create.editorx","serviceName":"com.wixpress.members.activitycounters.ActivityCounters"}}],"triggeredEvents":[],"serviceName":"com.wixpress.members.activitycounters.ActivityCounters","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MEMBERS.ACTIVITY_COUNTERS_READ"],"protoArtifactId":"com.wixpress.members:activity-counters-api","serviceArtifactId":"com.wixpress.members.activity-counters-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.members.activitycounters.QueryActivityCountersRequest","responseMessage":"com.wixpress.members.activitycounters.QueryActivityCountersResponse"},"legacyExamples":[{"name":"QueryActivityCounters","type":"METHOD","order":1,"content":{"title":"Query activity counters","description":"Retrieving counters with member id","request":"curl -X POST \\\n https://www.wixapis.com/members/v1/activity-counters/query \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\"\n }\n }\n }'","response":"{\n \"activityCounters\": [\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is public key\",\n \"public\": true,\n \"count\": 3\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is another public key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"QueryActivityCounters","type":"METHOD","content":{"title":"Query activity counters","description":"Retrieving counters with empty filter","request":"curl -X POST \\\n https://www.wixapis.com/members/v1/activity-counters/query \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {}\n }\n }'","response":"{\n \"activityCounters\": [\n {\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is my public key\",\n \"public\": true,\n \"count\": 1\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is public key\",\n \"public\": true,\n \"count\": 3\n }\n ]\n },\n {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is another public key\",\n \"public\": true,\n \"count\": 10\n }\n ]\n }\n ],\n \"metadata\": {\n \"count\": 3,\n \"offset\": 0,\n \"total\": 3\n }\n}"}},{"name":"QueryActivityCounters","type":"METHOD","order":2,"content":{"title":"Query activity counters","description":"Retrieving counters with two member ids and limit one","request":"curl -X POST \\\n https://www.wixapis.com/members/v1/activity-counters/query \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\n \"memberId\": {\n \"$in\": [\n \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\"\n ]\n }\n },\n \"paging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"activityCounters\": [\n {\n \"memberId\": \"bc93bbe5-228e-4468-a9ac-ebc15f90427e\",\n \"appId\": \"fb70a122-6276-4bbd-9cc6-ea9bc452b2a1\",\n \"counters\": [\n {\n \"key\": \"This is my public key\",\n \"public\": true,\n \"count\": 1\n }\n ]\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Query Activity Counters","slugifiedName":"query-activity-counters"},"permissionScopes":[{"name":"Manage Activity Counters","scopeId":"SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS"},{"name":"Read Activity Counters","scopeId":"SCOPE.DC-MEMBERS.READ-ACTIVITY-COUNTERS"}],"isAdminMethod":false}],"webhooks":[{"summary":"Activity Counter Updated","title":"Activity Counter Updated","description":"Triggered when an activity counter is updated.","permissions":["MEMBERS.ACTIVITY_COUNTERS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.members.v1.activity_counter","serviceName":"com.wixpress.members.activitycounters.ActivityCounters","domainEvent":"UPDATED","eventType":"wix.members.v1.activity_counter_updated","legacyExamples":[{"name":"ActivityCounterUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"4916088b-3bde-4666-826b-2f72e239d58c\",\n \"entityFqdn\": \"wix.members.v1.activitycounters\",\n \"slug\": \"updated\",\n \"entityId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"memberId\": \"987110f7-5100-4beb-a948-de610fd18f00\",\n \"appId\": \"7eb67052-4478-416e-b444-eff7accf6cea\",\n \"counters\": [\n {\n \"key\": \"This is key\",\n \"public\": true,\n \"count\": 1\n }\n ]\n }\n },\n \"eventTime\": \"2021-09-16T14:09:25.585986Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.members.activitycounters.ActivityCounter","contentLink":{"displayName":"Activity Counter Updated","slugifiedName":"activity-counter-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Activity Counters","scopeId":"SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS"},{"name":"Read Activity Counters","scopeId":"SCOPE.DC-MEMBERS.READ-ACTIVITY-COUNTERS"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Activity Counters API allows you to keep track of Wix site members' activity. See [Integrations](fallback::#integrations) for Wix App activities that are already counted.\n\nThis API gives you access to the counters on a site at a per-member, per-app level. This means: \n- Each app has it's own set of counters for the site members. If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.\n- The query and list methods for this API may return a large number of results for sites with many members.\n\nCounters are only activated when a site member actually performs the activity the counter tracks.\n\n## Integrations\n\nActivity Counters is currently integrated with these Wix apps and features:\n\n- [Wix Blog](fallback::https://dev.wix.com/docs/rest/business-solutions/blog/introduction) counts blog posts, comments, and likes.\n- [Wix Forum](fallback::https://support.wix.com/en/article/wix-forum-about-wix-forum) counts forum posts, comments, likes, and views.\n- [Wix Members Area](fallback::https://support.wix.com/en/article/about-the-members-area) counts followers in both directions (followed by / following).\n\n## Access\n\nYou can:\n - Read (but not set) public counts from any apps.\n - Read **and** set all counts for their own apps.\n\n## Initializing a counter\n\nTo create a new counter, call [Set Activity Counters](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78625e9e-72c0-4fb0-a41f-12eb7e1454f1slug::set-activity-counters*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/activity-counters/set-activity-counters)\n\n## Use cases\n\n**Most active writer widget.** \nAdd a \"most active writer\" widget to a home page, based on the number of posts each member creates.\n\n1. Get per-member post numbers for the Blog or Forum apps using [Get Activity Counters](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78625e9e-72c0-4fb0-a41f-12eb7e1454f1slug::get-activity-counters*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/activity-counters/get-activity-counters).\n2. Process counts and display in widget.\n \n**Most influential member widget.** \nAdd a \"most influential members\" widget to a community, based on how many likes and comments each member's posts get.\n\n1. Get per-member reaction numbers for the Blog or Forum apps using [Get Activity Counters](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78625e9e-72c0-4fb0-a41f-12eb7e1454f1slug::get-activity-counters*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/activity-counters/get-activity-counters).\n2. Process counts and display in widget.\n","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/appendices/docs/README.md"}],"components":{"schemas":{"com.wixpress.members.activitycounters.ActivityCounter":{"type":"object","properties":{"memberId":{"description":"Member ID.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"App ID.\n\nIf you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"counters":{"description":"Counters for this member.","title":"counters","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.members.activitycounters.Counter"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActivityCounter","description":""},"com.wixpress.members.activitycounters.Counter":{"type":"object","properties":{"key":{"description":"Key of the counter. Must be unique.","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"public":{"description":"Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter.","title":"public","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of activity.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Counter","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wix.diffmatoky.migration.DiffmatokyPayload":{"type":"object","properties":{"left":{"description":"","title":"left","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"right":{"description":"","title":"right","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"compareChannel":{"description":"","title":"compareChannel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"errorInformation":{"description":"","$ref":"#/components/schemas/com.wix.diffmatoky.migration.ErrorInformation","summary":"errorInformation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tags":{"description":"","title":"tags","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiffmatokyPayload","description":""},"com.wix.diffmatoky.migration.ErrorInformation":{"type":"object","properties":{"stackTrace":{"description":"","title":"stackTrace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ErrorInformation","description":""},"com.wixpress.members.activitycounters.SetActivityCountersRequest":{"type":"object","properties":{"memberId":{"description":"","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"counter":{"description":"Site member ID whose counter will be set.","$ref":"#/components/schemas/com.wixpress.members.activitycounters.Counter","summary":"counter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetActivityCountersRequest","description":""},"com.wixpress.members.activitycounters.SetActivityCountersResponse":{"type":"object","properties":{"activityCounter":{"description":"","$ref":"#/components/schemas/com.wixpress.members.activitycounters.ActivityCounter","summary":"activityCounter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetActivityCountersResponse","description":""},"com.wixpress.members.activitycounters.IncrementActivityCountersRequest":{"type":"object","properties":{"memberId":{"description":"","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"counter":{"description":"Site member ID whose counter will increment.","$ref":"#/components/schemas/com.wixpress.members.activitycounters.Counter","summary":"counter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncrementActivityCountersRequest","description":""},"com.wixpress.members.activitycounters.IncrementActivityCountersResponse":{"type":"object","properties":{"activityCounter":{"description":"","$ref":"#/components/schemas/com.wixpress.members.activitycounters.ActivityCounter","summary":"activityCounter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncrementActivityCountersResponse","description":""},"com.wixpress.members.activitycounters.GetActivityCountersRequest":{"type":"object","properties":{"memberId":{"description":"","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetActivityCountersRequest","description":""},"com.wixpress.members.activitycounters.GetActivityCountersResponse":{"type":"object","properties":{"activityCounters":{"description":"","title":"activityCounters","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.members.activitycounters.ActivityCounter"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetActivityCountersResponse","description":""},"com.wixpress.members.activitycounters.QueryActivityCountersRequest":{"type":"object","properties":{"query":{"description":"","$ref":"#/components/schemas/com.wixpress.members.activitycounters.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryActivityCountersRequest","description":""},"com.wixpress.members.activitycounters.Query":{"type":"object","properties":{"filter":{"description":"A filter object.","title":"filter","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Limit number of results.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Query","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.members.activitycounters.QueryActivityCountersResponse":{"type":"object","properties":{"activityCounters":{"description":"","title":"activityCounters","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.members.activitycounters.ActivityCounter"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Retrieved activity counters.","$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryActivityCountersResponse","description":""},"wix.common.PagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ANONYMOUS_VISITOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MEMBER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"WIX_USER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"APP","description":"","maturity":"GA","exposure":"PUBLIC"}]}}},"title":"Activity Counter","description":"Activity Counters service APIs","fqdn":"wix.members.v1.activity_counter"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Activity Counters API allows you to keep track of Wix site members' activity. See [Integrations](fallback::#integrations) for Wix App activities that are already counted.\n\nThis API gives you access to the counters on a site at a per-member, per-app level. This means: \n- Each app has it's own set of counters for the site members. If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.\n- The query and list methods for this API may return a large number of results for sites with many members.\n\nCounters are only activated when a site member actually performs the activity the counter tracks.\n\n## Integrations\n\nActivity Counters is currently integrated with these Wix apps and features:\n\n- [Wix Blog](fallback::https://dev.wix.com/docs/rest/business-solutions/blog/introduction) counts blog posts, comments, and likes.\n- [Wix Forum](fallback::https://support.wix.com/en/article/wix-forum-about-wix-forum) counts forum posts, comments, likes, and views.\n- [Wix Members Area](fallback::https://support.wix.com/en/article/about-the-members-area) counts followers in both directions (followed by / following).\n\n## Access\n\nYou can:\n - Read (but not set) public counts from any apps.\n - Read **and** set all counts for their own apps.\n\n## Initializing a counter\n\nTo create a new counter, call [Set Activity Counters](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78625e9e-72c0-4fb0-a41f-12eb7e1454f1slug::set-activity-counters*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/activity-counters/set-activity-counters)\n\n## Use cases\n\n**Most active writer widget.** \nAdd a \"most active writer\" widget to a home page, based on the number of posts each member creates.\n\n1. Get per-member post numbers for the Blog or Forum apps using [Get Activity Counters](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78625e9e-72c0-4fb0-a41f-12eb7e1454f1slug::get-activity-counters*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/activity-counters/get-activity-counters).\n2. Process counts and display in widget.\n \n**Most influential member widget.** \nAdd a \"most influential members\" widget to a community, based on how many likes and comments each member's posts get.\n\n1. Get per-member reaction numbers for the Blog or Forum apps using [Get Activity Counters](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78625e9e-72c0-4fb0-a41f-12eb7e1454f1slug::get-activity-counters*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/activity-counters/get-activity-counters).\n2. Process counts and display in widget.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}