Statistic Events 0.1.0 documentation

• Protobuf File Spec: social.proto

Published Messages (statManagement)

The service publishes one of these messages below.

statCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCode": "string",
    "status": "string",
    "name": "string",
    "description": "string",
    "maximum": 0,
    "minimum": 0,
    "defaultValue": 0,
    "incrementOnly": true,
    "setAsGlobal": true,
    "setBy": "string",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "ignoreAdditionalDataOnValueRejected": true
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCode	string	-
status	string	-
name	string	-
description	string	-
maximum	number (double)	-
minimum	number (double)	-
defaultValue	integer	-
incrementOnly	boolean	-
setAsGlobal	boolean	-
setBy	string	-
tags	object	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-
ignoreAdditionalDataOnValueRejected	boolean	-

payload.tags

This is a free-form object.

statDeleted

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCode": "string",
    "status": "string",
    "name": "string",
    "description": "string",
    "maximum": 0,
    "minimum": 0,
    "defaultValue": 0,
    "incrementOnly": true,
    "setAsGlobal": true,
    "setBy": "string",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "ignoreAdditionalDataOnValueRejected": true
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCode	string	-
status	string	-
name	string	-
description	string	-
maximum	number (double)	-
minimum	number (double)	-
defaultValue	integer	-
incrementOnly	boolean	-
setAsGlobal	boolean	-
setBy	string	-
tags	object	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-
ignoreAdditionalDataOnValueRejected	boolean	-

payload.tags

This is a free-form object.

statUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCode": "string",
    "status": "string",
    "name": "string",
    "description": "string",
    "maximum": 0,
    "minimum": 0,
    "defaultValue": 0,
    "incrementOnly": true,
    "setAsGlobal": true,
    "setBy": "string",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "ignoreAdditionalDataOnValueRejected": true
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCode	string	-
status	string	-
name	string	-
description	string	-
maximum	number (double)	-
minimum	number (double)	-
defaultValue	integer	-
incrementOnly	boolean	-
setAsGlobal	boolean	-
setBy	string	-
tags	object	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-
ignoreAdditionalDataOnValueRejected	boolean	-

payload.tags

This is a free-form object.

statImported

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "replacedStatCodes": [
      "string"
    ],
    "ignoredStatCodes": [
      "string"
    ],
    "newStatCodes": [
      "string"
    ],
    "failedStatCodes": [
      "string"
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
replacedStatCodes	array	-
ignoredStatCodes	array	-
newStatCodes	array	-
failedStatCodes	array	-

statExported

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCodes": [
      "string"
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCodes	array	-

Published Messages (statistic)

The service publishes one of these messages below.

statItemCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCode": "string",
    "userId": "string",
    "latestValue": 0,
    "inc": 0,
    "additionalData": {
      "property1": {},
      "property2": {}
    },
    "ignoreAdditionalDataOnValueRejected": true,
    "defaultValue": 0,
    "requestValue": 0,
    "updateStrategy": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCode	string	-
userId	string	-
latestValue	number (double)	-
inc	number (double)	-
additionalData	object	-
ignoreAdditionalDataOnValueRejected	boolean	-
defaultValue	number (double)	-
requestValue	number (double)	-
updateStrategy	string	-

payload.additionalData

This is a free-form object.

statItemUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCode": "string",
    "userId": "string",
    "latestValue": 0,
    "inc": 0,
    "additionalData": {
      "property1": {},
      "property2": {}
    },
    "ignoreAdditionalDataOnValueRejected": true,
    "defaultValue": 0,
    "requestValue": 0,
    "updateStrategy": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCode	string	-
userId	string	-
latestValue	number (double)	-
inc	number (double)	-
additionalData	object	-
ignoreAdditionalDataOnValueRejected	boolean	-
defaultValue	number (double)	-
requestValue	number (double)	-
updateStrategy	string	-

payload.additionalData

This is a free-form object.

statItemDeleted

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCode": "string",
    "userId": "string",
    "latestValue": 0,
    "inc": 0,
    "additionalData": {
      "property1": {},
      "property2": {}
    },
    "ignoreAdditionalDataOnValueRejected": true,
    "defaultValue": 0,
    "requestValue": 0,
    "updateStrategy": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCode	string	-
userId	string	-
latestValue	number (double)	-
inc	number (double)	-
additionalData	object	-
ignoreAdditionalDataOnValueRejected	boolean	-
defaultValue	number (double)	-
requestValue	number (double)	-
updateStrategy	string	-

payload.additionalData

This is a free-form object.

globalStatItemUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "statCode": "string",
    "latestValue": 0,
    "inc": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
statCode	string	-
latestValue	number (double)	-
inc	number (double)	-

Published Messages (statCycleManagement)

The service publishes one of these messages below.

statCycleCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "id": "string",
    "namespace": "string",
    "cycleType": "string",
    "resetTime": "string",
    "resetDay": 0,
    "resetDate": 0,
    "resetMonth": 0,
    "seasonPeriod": 0,
    "currentVersion": 0,
    "status": "string",
    "nextReset": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
id	string	-
namespace	string	-
cycleType	string	-
resetTime	string	-
resetDay	integer	-
resetDate	integer	-
resetMonth	integer	-
seasonPeriod	integer	-
currentVersion	integer	-
status	string	-
nextReset	string (date-time)	-
start	string (date-time)	-
end	string (date-time)	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-

statCycleUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "id": "string",
    "namespace": "string",
    "cycleType": "string",
    "resetTime": "string",
    "resetDay": 0,
    "resetDate": 0,
    "resetMonth": 0,
    "seasonPeriod": 0,
    "currentVersion": 0,
    "status": "string",
    "nextReset": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
id	string	-
namespace	string	-
cycleType	string	-
resetTime	string	-
resetDay	integer	-
resetDate	integer	-
resetMonth	integer	-
seasonPeriod	integer	-
currentVersion	integer	-
status	string	-
nextReset	string (date-time)	-
start	string (date-time)	-
end	string (date-time)	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-

statCycleReset

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "id": "string",
    "namespace": "string",
    "cycleType": "string",
    "resetTime": "string",
    "resetDay": 0,
    "resetDate": 0,
    "resetMonth": 0,
    "seasonPeriod": 0,
    "currentVersion": 0,
    "status": "string",
    "nextReset": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
id	string	-
namespace	string	-
cycleType	string	-
resetTime	string	-
resetDay	integer	-
resetDate	integer	-
resetMonth	integer	-
seasonPeriod	integer	-
currentVersion	integer	-
status	string	-
nextReset	string (date-time)	-
start	string (date-time)	-
end	string (date-time)	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-

statCycleDeleted

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "id": "string",
    "namespace": "string",
    "cycleType": "string",
    "resetTime": "string",
    "resetDay": 0,
    "resetDate": 0,
    "resetMonth": 0,
    "seasonPeriod": 0,
    "currentVersion": 0,
    "status": "string",
    "nextReset": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
id	string	-
namespace	string	-
cycleType	string	-
resetTime	string	-
resetDay	integer	-
resetDate	integer	-
resetMonth	integer	-
seasonPeriod	integer	-
currentVersion	integer	-
status	string	-
nextReset	string (date-time)	-
start	string (date-time)	-
end	string (date-time)	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-

Published Messages (statisticCycle)

The service publishes one of these messages below.

statItemCycleCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "cycleId": "string",
    "statCode": "string",
    "userId": "string",
    "updateStrategy": "string",
    "cycleVersion": 0,
    "latestValue": 0,
    "updateValue": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
cycleId	string	-
statCode	string	-
userId	string	-
updateStrategy	string	-
cycleVersion	integer	-
latestValue	number (double)	-
updateValue	number (double)	-

statItemCycleUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "cycleId": "string",
    "statCode": "string",
    "userId": "string",
    "updateStrategy": "string",
    "cycleVersion": 0,
    "latestValue": 0,
    "updateValue": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
namespace	string	-
cycleId	string	-
statCode	string	-
userId	string	-
updateStrategy	string	-
cycleVersion	integer	-
latestValue	number (double)	-
updateValue	number (double)	-

Schemas

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	as operator id
sessionId	string	-

stat

Name	Type	Description
namespace	string	-
statCode	string	-
status	string	-
name	string	-
description	string	-
maximum	number (double)	-
minimum	number (double)	-
defaultValue	integer	-
incrementOnly	boolean	-
setAsGlobal	boolean	-
setBy	string	-
tags	object	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-
ignoreAdditionalDataOnValueRejected	boolean	-

tags

This is a free-form object.

statItem

Name	Type	Description
namespace	string	-
statCode	string	-
userId	string	-
latestValue	number (double)	-
inc	number (double)	-
additionalData	object	-
ignoreAdditionalDataOnValueRejected	boolean	-
defaultValue	number (double)	-
requestValue	number (double)	-
updateStrategy	string	-

additionalData

This is a free-form object.

statCycle

Name	Type	Description
id	string	-
namespace	string	-
cycleType	string	-
resetTime	string	-
resetDay	integer	-
resetDate	integer	-
resetMonth	integer	-
seasonPeriod	integer	-
currentVersion	integer	-
status	string	-
nextReset	string (date-time)	-
start	string (date-time)	-
end	string (date-time)	-
createdAt	string (date-time)	-
updatedAt	string (date-time)	-

statCycleItem

Name	Type	Description
namespace	string	-
cycleId	string	-
statCode	string	-
userId	string	-
updateStrategy	string	-
cycleVersion	integer	-
latestValue	number (double)	-
updateValue	number (double)	-