Skip to main content

Statistic Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

Table of Contents

Operations

PUB statManagement Operation

Accepts one of the following messages:

Message statCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodestring----
payload.statusstring----
payload.namestring----
payload.descriptionstring----
payload.maximumnumber--format (double)-
payload.minimumnumber--format (double)-
payload.defaultValueinteger----
payload.incrementOnlyboolean----
payload.setAsGlobalboolean----
payload.setBystring----
payload.tagsobject----
payload.tags (additional properties)string----
payload.createdAtstring--format (date-time)-
payload.updatedAtstring--format (date-time)-
payload.ignoreAdditionalDataOnValueRejectedboolean----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodestring----
payload.statusstring----
payload.namestring----
payload.descriptionstring----
payload.maximumnumber--format (double)-
payload.minimumnumber--format (double)-
payload.defaultValueinteger----
payload.incrementOnlyboolean----
payload.setAsGlobalboolean----
payload.setBystring----
payload.tagsobject----
payload.tags (additional properties)string----
payload.createdAtstring--format (date-time)-
payload.updatedAtstring--format (date-time)-
payload.ignoreAdditionalDataOnValueRejectedboolean----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodestring----
payload.statusstring----
payload.namestring----
payload.descriptionstring----
payload.maximumnumber--format (double)-
payload.minimumnumber--format (double)-
payload.defaultValueinteger----
payload.incrementOnlyboolean----
payload.setAsGlobalboolean----
payload.setBystring----
payload.tagsobject----
payload.tags (additional properties)string----
payload.createdAtstring--format (date-time)-
payload.updatedAtstring--format (date-time)-
payload.ignoreAdditionalDataOnValueRejectedboolean----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statImported

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.replacedStatCodesarray<string>----
payload.replacedStatCodes (single item)string----
payload.ignoredStatCodesarray<string>----
payload.ignoredStatCodes (single item)string----
payload.newStatCodesarray<string>----
payload.newStatCodes (single item)string----
payload.failedStatCodesarray<string>----
payload.failedStatCodes (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statExported

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodesarray<string>----
payload.statCodes (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

PUB statistic Operation

Accepts one of the following messages:

Message statItemCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodestring----
payload.userIdstring----
payload.latestValuenumber--format (double)-
payload.incnumber--format (double)-
payload.additionalDataobject----
payload.additionalData (additional properties)object---additional properties are allowed
payload.ignoreAdditionalDataOnValueRejectedboolean----
payload.defaultValuenumber--format (double)-
payload.requestValuenumber--format (double)-
payload.updateStrategystring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statItemUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodestring----
payload.userIdstring----
payload.latestValuenumber--format (double)-
payload.incnumber--format (double)-
payload.additionalDataobject----
payload.additionalData (additional properties)object---additional properties are allowed
payload.ignoreAdditionalDataOnValueRejectedboolean----
payload.defaultValuenumber--format (double)-
payload.requestValuenumber--format (double)-
payload.updateStrategystring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statItemDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodestring----
payload.userIdstring----
payload.latestValuenumber--format (double)-
payload.incnumber--format (double)-
payload.additionalDataobject----
payload.additionalData (additional properties)object---additional properties are allowed
payload.ignoreAdditionalDataOnValueRejectedboolean----
payload.defaultValuenumber--format (double)-
payload.requestValuenumber--format (double)-
payload.updateStrategystring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message globalStatItemUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.statCodestring----
payload.latestValuenumber--format (double)-
payload.incnumber--format (double)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

PUB statCycleManagement Operation

Accepts one of the following messages:

Message statCycleCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.idstring----
payload.namespacestring----
payload.cycleTypestring----
payload.resetTimestring----
payload.resetDayinteger----
payload.resetDateinteger----
payload.resetMonthinteger----
payload.seasonPeriodinteger----
payload.currentVersioninteger----
payload.statusstring----
payload.nextResetstring--format (date-time)-
payload.startstring--format (date-time)-
payload.endstring--format (date-time)-
payload.createdAtstring--format (date-time)-
payload.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statCycleUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.idstring----
payload.namespacestring----
payload.cycleTypestring----
payload.resetTimestring----
payload.resetDayinteger----
payload.resetDateinteger----
payload.resetMonthinteger----
payload.seasonPeriodinteger----
payload.currentVersioninteger----
payload.statusstring----
payload.nextResetstring--format (date-time)-
payload.startstring--format (date-time)-
payload.endstring--format (date-time)-
payload.createdAtstring--format (date-time)-
payload.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statCycleReset

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.idstring----
payload.namespacestring----
payload.cycleTypestring----
payload.resetTimestring----
payload.resetDayinteger----
payload.resetDateinteger----
payload.resetMonthinteger----
payload.seasonPeriodinteger----
payload.currentVersioninteger----
payload.statusstring----
payload.nextResetstring--format (date-time)-
payload.startstring--format (date-time)-
payload.endstring--format (date-time)-
payload.createdAtstring--format (date-time)-
payload.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statCycleDeleted

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.idstring----
payload.namespacestring----
payload.cycleTypestring----
payload.resetTimestring----
payload.resetDayinteger----
payload.resetDateinteger----
payload.resetMonthinteger----
payload.seasonPeriodinteger----
payload.currentVersioninteger----
payload.statusstring----
payload.nextResetstring--format (date-time)-
payload.startstring--format (date-time)-
payload.endstring--format (date-time)-
payload.createdAtstring--format (date-time)-
payload.updatedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

PUB statisticCycle Operation

Accepts one of the following messages:

Message statItemCycleCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.cycleIdstring----
payload.statCodestring----
payload.userIdstring----
payload.updateStrategystring----
payload.cycleVersioninteger----
payload.latestValuenumber--format (double)-
payload.updateValuenumber--format (double)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}

Message statItemCycleUpdated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.namespacestring----
payload.cycleIdstring----
payload.statCodestring----
payload.userIdstring----
payload.updateStrategystring----
payload.cycleVersioninteger----
payload.latestValuenumber--format (double)-
payload.updateValuenumber--format (double)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringas operator id---
sessionIdstring----

Examples of payload (generated)

{
"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"
}