POST Stats/GetCounters

Returns statistics counters for use in gathering report information. A counter describes the information that Trust Protection Platform collects. To review counter descriptions, look in [Venafi installation folder\Schema\Counters]. The information is also available in the Venafi MMC Snap-In Collection. For more information, see Venafi Statistics Viewer.

Requirements

  • Permissions: The caller is not required to have any special permissions. Counters are public information unless they have the Sensitive flag set.
  • Token scope:   Statistics.

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

None.

Returns

For invalid requests, Get Counters returns:

  • HTTP 404 Error.

For valid requests, this API returns a HTTP 200 message and the following data in the message body.

Response description
Name Description
Counters An array of counters:
  • AName: The TagA that describes a report value.
  • BName: The TagB that describes a report value. If there is no TagB, this attribute is omitted.
  • CName: The TagC that describes a report value. If there is no TagC, this attribute is omitted.
  • Description: The description of the counter itself.
  • Name: The counter name.
  • StatsType: The counter ID.
  • ValueDescription: The report field description if any.

Error

The reason why data could not be retrieved. Otherwise, null.

Example: Get all available counters

Request

POST https://test.venafi.example/vedsdk/Stats/GetCounters
Authorization:Bearer 4MyGeneratedBearerTknz==
{


}

Response

HTTP/1.1 200 OK
{ 
   "Counters":[ 
      { 
         "AName":"Operational Context",
         "BName":"Name",
         "CName":"Version",
         "Description":"Operating systems in use",
         "Name":"Operating Systems",
         "StatsType":3014657
      },
      { 
         "AName":"CA Name",
         "Description":"CSR Posted to Certificate Authority",
         "Name":"CSR Posted",
         "StatsType":589825,
         "ValueDescription":"CA Reponse Time (ms)"
      },
      { 
         "AName":"CA Name",
         "Description":"Certificate Retrieved from Certificate Authority",
         "Name":"Certificate Retrieved",
         "StatsType":589826,
         "ValueDescription":"CA Reponse Time (ms)"
      },
      { 
         "AName":"CA Name",
         "Description":"Certificate Revoked at Certificate Authority",
         "Name":"Certificate Revoked",
         "StatsType":589827,
         "ValueDescription":"CA Reponse Time (ms)"
      },
 ...
   ],
   "Error":""
}