GET/api/events/{category}
Get events
Query parameters:
| Header | Type | Description | Required |
|---|---|---|---|
| category | Available values: System, Clients, Queue, Deals | Events category filter | false |
| pageNumber | integer | Paging: position | false |
| pageSize | integer | Paging: returned items count | false |
Headers
| Header | Value | Required |
|---|---|---|
| Accept | application/json | true |
| Authorization | Your authorization token | true |
| Channel | Your channel value | true |
| x-api-version | 2.0 | true |
Request Example
curl -X GET "https://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.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
| Content Type | Value |
|---|---|
| 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 Type | Value |
|---|---|
| any | Depends on authentication proxy |
Returned in case of unpredictable error.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
| Content Type | Value |
|---|---|
| application/json |
Example body:
{
"errorMessage": "Internal error"
}POST/api/events/{eventUid}/ack
Ack event
Query parameters:
| Header | Type | Description | Required |
|---|---|---|---|
| eventUid | string($uuid) | Unique identifier of the event | true |
Headers
| Header | Value | Required |
|---|---|---|
| Accept | application/json | true |
| Authorization | Your authorization token | true |
| Channel | Your channel value | true |
| x-api-version | 2.0 | true |
Request Example
curl -X GET "https://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.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
| Content Type | Value |
|---|---|
| application/json | Earliest unprocessed event time (type: string("yyyy"-"MM"-"dd"T"HH":"mm":"ss"."fffffffzzz")) |
Example body:
2020-08-04T21:23:14.813Returned in case of request validation error.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
| Content Type | Value |
|---|---|
| application/json |
Example body:
{
"errorMessage": "Event not found"
}Returned if the authentication credentials are incorrect or missing.
| Content Type | Value |
|---|---|
| any | Depends on authentication proxy |
Returned in case of unpredictable error.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
| Content Type | Value |
|---|---|
| application/json |
Example body:
{
"errorMessage": "Internal error"
}POST/api/events/reset/{dateTimeUTC}
Reinitialise events
Query parameters:
| Header | Type | Description | Required |
|---|---|---|---|
| dateTimeUTC | string (ISO8601) | The lower time limit for reinitialization | true |
Headers
| Header | Value | Required |
|---|---|---|
| Accept | application/json | true |
| Authorization | Your authorization token | true |
| Channel | Your channel value | true |
| x-api-version | 2.0 | true |
Request Example
curl -X GET "https://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.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
Returned in case of request validation error.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
| Content Type | Value |
|---|---|
| application/json |
Example body:
{
"errorMessage": "Error description"
}Returned if the authentication credentials are incorrect or missing.
| Content Type | Value |
|---|---|
| any | Depends on authentication proxy |
Returned in case of unpredictable error.
| Headers | Value |
|---|---|
| content-type | application/json; charset=utf-8 |
| api-supported-versions | Supported versions. Example: 1.0, 2.0 |
| Content Type | Value |
|---|---|
| application/json |
Example body:
{
"errorMessage": "Internal error"
}