POST api/reporting/chart

Run Realtime Chart 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 ReportChartRequestDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

Facets

The collection of facets.

Collection of ChartReportFacet

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.

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,
      2
    ],
    "From": "2026-08-04T21:01:01.4844648Z",
    "To": "2026-08-04T21:01:01.4844648Z",
    "BranchId": 1,
    "IncludeDrafts": true,
    "RoleTypes": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Name": "sample string 1",
    "Facets": [
      0,
      0
    ],
    "NegotiatorIds": [
      1,
      2
    ],
    "From": "2026-08-04T21:01:01.4844648Z",
    "To": "2026-08-04T21:01:01.4844648Z",
    "BranchId": 1,
    "IncludeDrafts": true,
    "RoleTypes": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

Response Information

Resource Description

The response returned after the operation completes.

Collection of ReportChartResultDataContract
NameDescriptionTypeAdditional information
Facet

The facet classification.

ChartReportFacet

None.

Name

The name value.

string

None.

NegotiatorId

The unique identifier of the related negotiator resource.

integer

None.

Results

The collection of results.

Collection of ChartResultDataContract

None.

BranchId

The unique identifier of the related branch resource.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BranchId": 1,
    "Facet": "OriginTotals",
    "Name": "sample string 1",
    "NegotiatorId": 1,
    "Results": [
      {
        "Name": "sample string 1",
        "Value": 2.1
      },
      {
        "Name": "sample string 1",
        "Value": 2.1
      }
    ]
  },
  {
    "BranchId": 1,
    "Facet": "OriginTotals",
    "Name": "sample string 1",
    "NegotiatorId": 1,
    "Results": [
      {
        "Name": "sample string 1",
        "Value": 2.1
      },
      {
        "Name": "sample string 1",
        "Value": 2.1
      }
    ]
  }
]