POST api/reporting/realtime

Run Realtime Report. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The report requests value supplied with the request.

Collection of ReportRequestDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Facets	The collection of facets.	Collection of ReportFacet	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
From	The from, expressed as a date and time.	date	None.
To	The to, expressed as a date and time.	date	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
IncludeDrafts	Indicates whether include drafts is true.	boolean	None.
RoleTypes	The collection of role types.	Collection of string	None.
ExcludeRoleTypes	The collection of exclude role types.	Collection of string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Facets": [
      0,
      0
    ],
    "NegotiatorIds": [
      1,
      1
    ],
    "From": "2026-08-05T00:17:28.1575399Z",
    "To": "2026-08-05T00:17:28.1575399Z",
    "BranchId": 1,
    "IncludeDrafts": true,
    "RoleTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "ExcludeRoleTypes": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Name": "sample string 1",
    "Facets": [
      0,
      0
    ],
    "NegotiatorIds": [
      1,
      1
    ],
    "From": "2026-08-05T00:17:28.1575399Z",
    "To": "2026-08-05T00:17:28.1575399Z",
    "BranchId": 1,
    "IncludeDrafts": true,
    "RoleTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "ExcludeRoleTypes": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

Response Information

Resource Description

The response returned after the operation completes.

Collection of ReportResultDataContract

Name	Description	Type	Additional information
Facet	The facet classification.	ReportFacet	None.
Value	The value represented by this field.	decimal number	None.
Name	The name value.	string	None.
NegotiatorId	The unique identifier of the related negotiator resource.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Facet": "ValuationsBooked",
    "Value": 1.1,
    "Name": "sample string 2",
    "NegotiatorId": 3
  },
  {
    "Facet": "ValuationsBooked",
    "Value": 1.1,
    "Name": "sample string 2",
    "NegotiatorId": 3
  }
]