POST api/negotiator/intervaleventcounts

Return interval based event counts for negotiators. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The negotiator event count data contract supplied with the request.

NegotiatorEventCountDataContract
NameDescriptionTypeAdditional information
Interval

The interval classification.

DateInterval

None.

NegotiatorIds

The unique identifiers of the related negotiator resources.

Collection of integer

None.

StartDate

The start date, expressed as a date and time.

date

None.

EndDate

The end date, expressed as a date and time.

date

None.

EventCategory

The event category value.

EnumDataContract

None.

EventType

The event type value.

EnumDataContract

None.

RoleType

The role type value.

EnumDataContract

None.

BranchId

The unique identifier of the related branch resource.

integer

None.

IncludeDrafts

Indicates whether include drafts is true.

boolean

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Interval": 0,
  "NegotiatorIds": [
    1,
    2
  ],
  "StartDate": "2026-07-23T08:15:32.8869225Z",
  "EndDate": "2026-07-23T08:15:32.8869225Z",
  "EventCategory": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "EventType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RoleType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "BranchId": 1,
  "IncludeDrafts": true
}

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfNegotiatorEventCountResultDataContract
NameDescriptionTypeAdditional information
TotalCount

The total count value.

integer

None.

CurrentCount

The current count value.

integer

None.

PageSize

The page size value.

integer

None.

PageNumber

The page number value.

integer

None.

Collection

The collection of collection.

Collection of NegotiatorEventCountResultDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "DateTime": "2026-07-23T08:15:32.9025513Z",
      "Count": 2
    },
    {
      "DateTime": "2026-07-23T08:15:32.9025513Z",
      "Count": 2
    }
  ]
}