GET/api/events/{category}

Get events

Query parameters:

HeaderTypeDescriptionRequired
categoryAvailable values: System, Clients, Queue, DealsEvents category filterfalse
pageNumberintegerPaging: positionfalse
pageSizeintegerPaging: returned items countfalse

Headers

HeaderValueRequired
Acceptapplication/jsontrue
AuthorizationYour authorization tokentrue
ChannelYour channel valuetrue
x-api-version2.0true

Request Example

curl -X GET "http://qrm1.kekker.com/api/events"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "channel: {CHANNEL}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 5,
  "data": [
    {
      "objectId": 10025,
      "error": "Unknown client QRM4",
      "eventUid": "3148a02e-862e-40eb-87af-d214b8e7ba2f",
      "event": "ErrorQueueEvent",
      "category": "Queue",
      "timestamp": "2020-08-04T06:38:39.28"
    },
    {
      "objectId": 10023,
      "dealId": "ad04c39314184ac0847304fc22eaac75:57af8d5e2cde483b84f761038bd902ff",
      "eventUid": "1fdb07d4-e260-4e7e-aca9-69db3f0c2658",
      "event": "SuccessQueueEvent",
      "category": "Queue",
      "timestamp": "2020-08-04T21:41:05.183"
    },
    {
      "objectId": "ad04c39314184ac0847304fc22eaac75:57af8d5e2cde483b84f761038bd902ff",
      “localObjectId”:3487,
      "eventUid": "d4eb2098-3890-49c8-8029-729752c57e65",
      "event": "DealUpdated",
      "category": "Deals",
      "timestamp": "2020-08-04T21:41:05.183"
    },
    {
      "queueId": 10022,
      "dealId": "ad04c39314184ac0847304fc22eaac75:57af8d5e2cde483b84f761038bd902ff",
      "eventUid": "d256d4ce-b253-490f-83a9-68195c0f2bbe",
      "event": "Success",
      "category": "Queue",
      "timestamp": "2020-08-04T21:23:14.813"
    },
    {
      "objectId": "ad04c39314184ac0847304fc22eaac75:57af8d5e2cde483b84f761038bd902ff",
      “localObjectId”:3487,
      "eventUid": "9a51267f-ce6b-4347-90cd-52d72a12c969",
      "event": "DealUpdated",
      "category": "Deals",
      "timestamp": "2020-08-04T21:23:14.813"
    }
  ]
}

Returned if the authentication credentials are incorrect or missing.

Content TypeValue
anyDepends on authentication proxy

Returned in case of unpredictable error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "errorMessage": "Internal error"
}

POST/api/events/{eventUid}/ack

Ack event

Query parameters:

HeaderTypeDescriptionRequired
eventUidstring($uuid)Unique identifier of the eventtrue

Headers

HeaderValueRequired
Acceptapplication/jsontrue
AuthorizationYour authorization tokentrue
ChannelYour channel valuetrue
x-api-version2.0true

Request Example

curl -X GET "http://qrm1.kekker.com/api/events/56d5b7a2-2b5f-4f53-b790-d7448efc0234/ack"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "channel: {CHANNEL}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/jsonEarliest unprocessed event time (type: string("yyyy"-"MM"-"dd"T"HH":"mm":"ss"."fffffffzzz"))

Example body:

2020-08-04T21:23:14.813

Returned in case of request validation error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "errorMessage": "Event not found"
}

Returned if the authentication credentials are incorrect or missing.

Content TypeValue
anyDepends on authentication proxy

Returned in case of unpredictable error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "errorMessage": "Internal error"
}

POST/api/events/reset/{dateTimeUTC}

Reinitialise events

Query parameters:

HeaderTypeDescriptionRequired
dateTimeUTCstring (ISO8601)The lower time limit for reinitializationtrue

Headers

HeaderValueRequired
Acceptapplication/jsontrue
AuthorizationYour authorization tokentrue
ChannelYour channel valuetrue
x-api-version2.0true

Request Example

curl -X GET  "http://qrm1.kekker.com/api/events/reset/2020-08-04T06:38:39.2"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "channel: {CHANNEL}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful. Response body is empty.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0

Returned in case of request validation error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "errorMessage": "Error description"
}

Returned if the authentication credentials are incorrect or missing.

Content TypeValue
anyDepends on authentication proxy

Returned in case of unpredictable error.

HeadersValue
content-typeapplication/json; charset=utf-8
api-supported-versionsSupported versions. Example: 1.0, 2.0
Content TypeValue
application/json

Example body:

{
  "errorMessage": "Internal error"
}

Test the platform’s powerful features now

By submitting this form, you confirm that you have read and agree to our privacy policy and terms of service