POST api/list/stats/certificatestats

Returns a list of totals for certificates stats Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The filters value supplied with the request.

Collection of PmCertificatesAndLicencesListFilterDataContract

Name	Description	Type	Additional information
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
ExpiryDateFrom	The expiry date from, expressed as a date and time.	date	None.
ExpiryDateTo	The expiry date to, expressed as a date and time.	date	None.
TeamGroupIds	The unique identifiers of the related team group resources.	Collection of integer	None.
CertificateTypes	The collection of certificate types.	Collection of string	None.
DocumentUploaded	Indicates whether document uploaded is true.	boolean	None.
ServiceLevels	The collection of service levels.	Collection of string	None.
IncludeActiveTenancies	Indicates whether include active tenancies is true.	boolean	None.
LatestCertificatesOnly	Indicates whether latest certificates only is true.	boolean	None.
Sort	The sort classification.	PmCertificatesAndLicencesListSort	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Term	The term value.	string	None.
OrderByDescending	Indicates whether order by descending is true.	boolean	None.
Name	The name value.	string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

[
  {
    "BranchIds": [
      1,
      2
    ],
    "ExpiryDateFrom": "2026-08-05T00:22:41.0668259Z",
    "ExpiryDateTo": "2026-08-05T00:22:41.0668259Z",
    "TeamGroupIds": [
      1,
      2
    ],
    "CertificateTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "DocumentUploaded": true,
    "ServiceLevels": [
      "sample string 1",
      "sample string 2"
    ],
    "IncludeActiveTenancies": true,
    "LatestCertificatesOnly": true,
    "Sort": 1,
    "PageSize": 1,
    "PageNumber": 1,
    "Term": "sample string 1",
    "OrderByDescending": true,
    "Name": "sample string 2"
  },
  {
    "BranchIds": [
      1,
      2
    ],
    "ExpiryDateFrom": "2026-08-05T00:22:41.0668259Z",
    "ExpiryDateTo": "2026-08-05T00:22:41.0668259Z",
    "TeamGroupIds": [
      1,
      2
    ],
    "CertificateTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "DocumentUploaded": true,
    "ServiceLevels": [
      "sample string 1",
      "sample string 2"
    ],
    "IncludeActiveTenancies": true,
    "LatestCertificatesOnly": true,
    "Sort": 1,
    "PageSize": 1,
    "PageNumber": 1,
    "Term": "sample string 1",
    "OrderByDescending": true,
    "Name": "sample string 2"
  }
]

Response Information

Resource Description

The response returned after the operation completes.

Collection of ListStatsDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Value	The value represented by this field.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Value": 2
  },
  {
    "Name": "sample string 1",
    "Value": 2
  }
]