Timeline APIs

Post Events Statistics (POST)

Returns statistical data for events in the timeline.

Route

URI	/api/v1/TimeLine/EventStatistics
Method	POST
Result	JSON – EventStatisticsModel

Parameters

{
    "StartTime": "2025-12-30T07:27:00",
    "EndTime": "2026-01-13T07:27:00",
    "Filters": [],
    "Scale": "Day"
}

Example

POST http://localhost/api/v1/TimeLine/EventStatistics
Content-Type: application/json

{query parameters}

Post Events List (POST)

Returns a list of events for the timeline.

Route

URI	/api/v1/TimeLine/Events
Method	POST
Result	JSON – Array of EventModel

Parameters

{
    "StartTime": "2025-12-30T07:27:00",
    "EndTime": "2026-01-13T07:27:00",
    "Filters": []
}

Example

POST http://localhost/api/v1/TimeLine/Events
Content-Type: application/json

{query parameters}

Get Events Categories (GET)

Returns available categories for filtering timeline events.

Route

URI	/api/v1/TimeLine/FilterCategories
Method	GET
Result	JSON – Array of CategoryModel

Parameters

None

Example

GET http://localhost/api/v1/TimeLine/FilterCategories
[
    {
        "Id": 0,
        "DisplayName": "Provider",
        "PropertyName": "Provider",
        "FilterValues": [
            {
                "Id": 1,
                "DisplayName": "N/A"
            },
            {
                "Id": 4,
                "DisplayName": "eng.protected-networks.local"
            },
            {
                "Id": 2,
                "DisplayName": "lab.protected-networks.local"
            }
        ]
    },
    {
        "Id": 1,
        "DisplayName": "Event type",
        "PropertyName": "EventType",
        "FilterValues": [
            {
                "Id": 6,
                "DisplayName": "Active Directory user or computer account created"
            },
            {
                "Id": 10,
                "DisplayName": "Attribute changed"
            },
            {
                "Id": 35,
                "DisplayName": "Changes on alert definitions"
            },
            {
                "Id": 40,
                "DisplayName": "External Script"
            },
            {
                "Id": 8,
                "DisplayName": "Password reset"
            }
        ]
    },
    {
        "Id": 2,
        "DisplayName": "Technology",
        "PropertyName": "Technology",
        "FilterValues": [
            {
                "Id": 0,
                "DisplayName": "N/A"
            },
            {
                "Id": 1,
                "DisplayName": "Active Directory"
            }
        ]
    },
    {
        "Id": 3,
        "DisplayName": "Severity",
        "PropertyName": "Severity",
        "FilterValues": [
            {
                "Id": 0,
                "DisplayName": "Information"
            },
            {
                "Id": 1,
                "DisplayName": "Warning"
            },
            {
                "Id": 2,
                "DisplayName": "Critical"
            }
        ]
    },
    {
        "Id": 4,
        "DisplayName": "Source type",
        "PropertyName": "SourceType",
        "FilterValues": [
            {
                "Id": 1,
                "DisplayName": "Logbook"
            }
        ]
    },
    {
        "Id": 5,
        "DisplayName": "Machine name (Collector)",
        "PropertyName": "GafferMachineName",
        "FilterValues": [
            {
                "Id": 1,
                "DisplayName": "N/A"
            },
            {
                "Id": 3,
                "DisplayName": "brn-cld-385"
            }
        ]
    }
]

Get Events (POST)

Returns all possible filter categories and their filter values

Route

URI	/api/v1/TimeLine/Events
Method	POST
Result	JSON – EventModel[]

Parameters

Name	Type	Mandatory	Description
value	EventsRequest	No

Response Structure Returns EventModel[] object containing:

• Id: long value

• EventTime: DateTime value

• Severity: int value

• SourceType: int value

• SourceId: string value

• EventType: int value

• EventId: int value

• Technology: int value

• Provider: int value

• Title: string value

• GafferMachineName: int value

• AffectedObjectDisplayName: string value

• AffectedObjectId: string value

• AuthorDisplayName: string value

• AuthorAccountId: string value

• AuthorAccountProvider: string value

• AuthorAccountType: int value

• Description: string value

Example

POST http://localhost/api/v1/TimeLine/Events

Example Response

{     
   "Id": 1,     
   "EventTime": "2026-01-15T10:30:00Z",     
   "Severity": 1,     
   "SourceType": 1,     
   "SourceId": "sample",     
   "EventType": 1,     
   "EventId": 1,     
   "Technology": 1,     
   "Provider": 1,     
   "Title": "sample",     
   "GafferMachineName": 1,     
   "AffectedObjectDisplayName": "sample",     
   "AffectedObjectId": "sample",     
   "AuthorDisplayName": "sample",     
   "AuthorAccountId": "sample",     
   "AuthorAccountProvider": "sample",     
   "AuthorAccountType": 1,     
   "Description": "sample" 
}

Get Event Statistics (POST)

Returns all possible filter categories and their filter values

Route

URI	/api/v1/TimeLine/EventStatistics
Method	POST
Result	JSON – EventStatisticModel[]

Parameters

Name	Type	Mandatory	Description
value	EventStatisticsRequest	No

Response Structure Returns EventStatisticModel[] object containing:

• StartTime: DateTime value

• Count: int value

Example

POST http://localhost/api/v1/TimeLine/EventStatistics

Example Response

{     "StartTime": "2026-01-15T10:30:00Z",     "Count": 1 }

Get Filters (GET)

Returns all possible filter categories and their filter values

Route

URI	/api/v1/TimeLine/FilterCategories
Method	GET
Result	JSON – FilterCategoryModel[]

Parameters

None

Response Structure Returns FilterCategoryModel[] object containing:

• Id: int value

• DisplayName: string value

• PropertyName: string value

• FilterValues: DisplayValue[] value

Example

GET http://localhost/api/v1/TimeLine/FilterCategories

Example Response

{     "Id": 1,     "DisplayName": "sample",     "PropertyName": "sample",     "FilterValues": {} }