EventTypeCountItem

Represents the result of a call to the API to get downstream statuses for a controller

Overview of EventTypeCountItem goes here.

EventTypeCountItem Properties

EventTypeCountItem

Field Type Inherited from Description
CommonName String EventTypeCountItem Gets or sets the CommonName of the Event Type.
Count Int64 EventTypeCountItem Gets or sets the Count of the Event Type.
DisplayName String EventTypeCountItem Gets or sets the DisplayName of the Event Type, which is the CommonName of the EventType followed by the CommonName of the App.
Key String EventTypeCountItem Gets or sets the Key of the Event Type.

JSON Structure of EventTypeCountItem

{
   "CommonName"	:	"String",
   "Count"	:	"Int64",
   "DisplayName"	:	"String",
   "Key"	:	"String"
}

Get Events Async

Example in C#

// Returns: IEnumerable<EventMessageData>
var eventMessageData = await client.GetEventsAsync(FolderInfo folder, Int32 page, Int32 pageSize, Boolean includeSubFolders, Boolean includeSharedInstances, Boolean spanScope, Boolean requiresAck, DateTime startingOn, DateTime endingOn, TimeSpan timeWindowStarting, TimeSpan timeWindowEnding, Int32 priorityThreshold, String forKeys, String forAllKeys, String sinceKey, String query, String forPeopleInAccessLevels);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/events?page=0&pageSize=1000&includeSubFolders=False&includeSharedInstances=False&spanScope=False&requiresAck=False&priorityThreshold=0 \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Get Event Type Counts Async

Example in C#

// Returns: IEnumerable<EventTypeCountItem>
var eventTypeCountItem = await client.GetEventTypeCountsAsync(FolderInfo folder, Boolean includeChild, Int32 priorityThreshold, DateTime startingOn, DateTime endingOn, String forKeys, String forAllKeys);

Example in CURL



            curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/events/count-by-event-type?spanScope=False&priorityThreshold=10&startingOn=2025-08-01T00:00:00Z&endingOn=2025-08-02T00:00:00&forKeys=KEY1&forKeys=KEY2&forAllKeys=KEY3&forAllKeys=KEY4 \
               -H 'Authorization: Bearer  TOKEN_GOES_HERE'\
               -H 'Content-Type: application/json'

Get Most Recent Event For Object Async

Example in C#

// Returns: IEnumerable<EventMessageSummaryItem>
var eventMessageSummaryItem = await client.GetMostRecentEventForObjectAsync(FolderInfo folder, DateTime since, String keys);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/lastevent?since=2019-02-25T21%3A27%3A07.6505885Z \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '["OBJECT_TO_CHECK_KEY"]'

Publish Event Async

Example in C#

// Returns: nothing
await client.PublishEventAsync(FolderInfo folder, String apiKey, MonikerItem eventTypeMoniker, DateTime occuredOn, Object data, ObjectLinkItem linkedObjects);

Example in CURL



           curl -X POST \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/eventmessagesink \
               -H 'Authorization:  Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.EventMessagePosting, Feenics.Keep.WebApi.Model",
                       "OccurredOn":"2019-01-23T19:30:49.10947Z",
                       "AppKey":"MercuryCommands",
                       "EventTypeMoniker":
                      {
                           "$type":"Feenics.Keep.WebApi.Model.MonikerItem, Feenics.Keep.WebApi.Model",
                           "Namespace":"MercuryServiceCommands",
                           "Nickname":"mercury:command-simulateKeyPress"
                       },
                       "RelatedObjects":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":"/api/f/INSTANCE.KEY/peripherals/READER.KEY",
                               "LinkedObjectKey":"READER.KEY",
                               "CommonName":"ReaderExampleForCurl",
                               "Relation":"Reader",
                               "MetaDataBson":null
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":"/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY",
                               "LinkedObjectKey":"CONTROLLER.KEY",
                               "CommonName":"ControllerExampleForCurl",
                               "Relation":"Controller",
                               "MetaDataBson":null
                           }
                       ],
                       "EventDataBsonBase64":"FAAAAAJLZXlzAAUAAAA3MDUyAAA="
                   }'