GET Analytics Certificates Count

The GET /Analytics/Certificates/Count method returns the number of certificates that match the supplied parameters. This method returns HTTP 200 OK on a success with the certificate count.

Note:  The Analytics collectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). is in beta; endpoints and parameters are subject to change in future releases of Keyfactor Command.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/certificates/collections/read/
OR
/certificates/collections/read/#/ (where # is a reference to a specific certificate collection ID)

Permissions for certificates can be configured at multiple levels. You can apply them system-wide—for all certificates—or use fine-grained control by assigning permissions at the certificate collection level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions for more information about system-wide versus more targeted permission models.

Table 220: GET Analytics Certificates Count Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (e.g., field1 -eq value1 AND field2 -gt value2). The default is to return all records. For querying guidelines, refer to: GET Certificates The query fields supported for this endpoint are the same as those for certificate search. Advanced searches are supported.

This allows for creating a custom query to generate a certificate count. The query should be formatted like the context field on the certificate search page, for example:

(CN -contains "appsrvr" AND IssuedDate -ge "01/01/2022") OR (CN -contains "appsrvr" AND TemplateShortName -contains "web")
collectionId Query

Required. An integer that represents the ID of the collection to query to generate the certificate count.

Use 0 for All Certificates (built-in collection).

Use the GET Certificate Collections method to retrieve a list of all the certificate collections to determine the collection ID.

Table 221: GET Analytics Certificates Count Response Data

Name In Description
Count Body

An integer that represents the count of certificates that match the supplied parameters.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the bottom of the Management Portal side menu.