Skip to main content

Statistic Events 0.1.0 documentation

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

NameTypeDescription
namespacestring-
statCodestring-
statusstring-
namestring-
descriptionstring-
maximumnumber (double)-
minimumnumber (double)-
defaultValueinteger-
incrementOnlyboolean-
setAsGlobalboolean-
setBystring-
tagsobject-
createdAtstring (date-time)-
updatedAtstring (date-time)-
ignoreAdditionalDataOnValueRejectedboolean-
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

NameTypeDescription
namespacestring-
statCodestring-
statusstring-
namestring-
descriptionstring-
maximumnumber (double)-
minimumnumber (double)-
defaultValueinteger-
incrementOnlyboolean-
setAsGlobalboolean-
setBystring-
tagsobject-
createdAtstring (date-time)-
updatedAtstring (date-time)-
ignoreAdditionalDataOnValueRejectedboolean-
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

NameTypeDescription
namespacestring-
statCodestring-
statusstring-
namestring-
descriptionstring-
maximumnumber (double)-
minimumnumber (double)-
defaultValueinteger-
incrementOnlyboolean-
setAsGlobalboolean-
setBystring-
tagsobject-
createdAtstring (date-time)-
updatedAtstring (date-time)-
ignoreAdditionalDataOnValueRejectedboolean-
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

NameTypeDescription
namespacestring-
replacedStatCodesarray-
ignoredStatCodesarray-
newStatCodesarray-
failedStatCodesarray-

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

NameTypeDescription
namespacestring-
statCodesarray-

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

NameTypeDescription
namespacestring-
statCodestring-
userIdstring-
latestValuenumber (double)-
incnumber (double)-
additionalDataobject-
ignoreAdditionalDataOnValueRejectedboolean-
defaultValuenumber (double)-
requestValuenumber (double)-
updateStrategystring-
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

NameTypeDescription
namespacestring-
statCodestring-
userIdstring-
latestValuenumber (double)-
incnumber (double)-
additionalDataobject-
ignoreAdditionalDataOnValueRejectedboolean-
defaultValuenumber (double)-
requestValuenumber (double)-
updateStrategystring-
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

NameTypeDescription
namespacestring-
statCodestring-
userIdstring-
latestValuenumber (double)-
incnumber (double)-
additionalDataobject-
ignoreAdditionalDataOnValueRejectedboolean-
defaultValuenumber (double)-
requestValuenumber (double)-
updateStrategystring-
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

NameTypeDescription
namespacestring-
statCodestring-
latestValuenumber (double)-
incnumber (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

NameTypeDescription
idstring-
namespacestring-
cycleTypestring-
resetTimestring-
resetDayinteger-
resetDateinteger-
resetMonthinteger-
seasonPeriodinteger-
currentVersioninteger-
statusstring-
nextResetstring (date-time)-
startstring (date-time)-
endstring (date-time)-
createdAtstring (date-time)-
updatedAtstring (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

NameTypeDescription
idstring-
namespacestring-
cycleTypestring-
resetTimestring-
resetDayinteger-
resetDateinteger-
resetMonthinteger-
seasonPeriodinteger-
currentVersioninteger-
statusstring-
nextResetstring (date-time)-
startstring (date-time)-
endstring (date-time)-
createdAtstring (date-time)-
updatedAtstring (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

NameTypeDescription
idstring-
namespacestring-
cycleTypestring-
resetTimestring-
resetDayinteger-
resetDateinteger-
resetMonthinteger-
seasonPeriodinteger-
currentVersioninteger-
statusstring-
nextResetstring (date-time)-
startstring (date-time)-
endstring (date-time)-
createdAtstring (date-time)-
updatedAtstring (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

NameTypeDescription
idstring-
namespacestring-
cycleTypestring-
resetTimestring-
resetDayinteger-
resetDateinteger-
resetMonthinteger-
seasonPeriodinteger-
currentVersioninteger-
statusstring-
nextResetstring (date-time)-
startstring (date-time)-
endstring (date-time)-
createdAtstring (date-time)-
updatedAtstring (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

NameTypeDescription
namespacestring-
cycleIdstring-
statCodestring-
userIdstring-
updateStrategystring-
cycleVersioninteger-
latestValuenumber (double)-
updateValuenumber (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

NameTypeDescription
namespacestring-
cycleIdstring-
statCodestring-
userIdstring-
updateStrategystring-
cycleVersioninteger-
latestValuenumber (double)-
updateValuenumber (double)-

Schemas

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstringas operator id
sessionIdstring-

stat

NameTypeDescription
namespacestring-
statCodestring-
statusstring-
namestring-
descriptionstring-
maximumnumber (double)-
minimumnumber (double)-
defaultValueinteger-
incrementOnlyboolean-
setAsGlobalboolean-
setBystring-
tagsobject-
createdAtstring (date-time)-
updatedAtstring (date-time)-
ignoreAdditionalDataOnValueRejectedboolean-

tags

This is a free-form object.

statItem

NameTypeDescription
namespacestring-
statCodestring-
userIdstring-
latestValuenumber (double)-
incnumber (double)-
additionalDataobject-
ignoreAdditionalDataOnValueRejectedboolean-
defaultValuenumber (double)-
requestValuenumber (double)-
updateStrategystring-

additionalData

This is a free-form object.

statCycle

NameTypeDescription
idstring-
namespacestring-
cycleTypestring-
resetTimestring-
resetDayinteger-
resetDateinteger-
resetMonthinteger-
seasonPeriodinteger-
currentVersioninteger-
statusstring-
nextResetstring (date-time)-
startstring (date-time)-
endstring (date-time)-
createdAtstring (date-time)-
updatedAtstring (date-time)-

statCycleItem

NameTypeDescription
namespacestring-
cycleIdstring-
statCodestring-
userIdstring-
updateStrategystring-
cycleVersioninteger-
latestValuenumber (double)-
updateValuenumber (double)-