The default format is JSON. The servlet will use the HTTP Accept header if no specific format is specified.

URL

/api/v1/metrics{.format}

Method

GET

Formats

JSON, XML

Query parameters
name
Limits the results to metrics whose names contain a matching substring. The search is not case-sensitive.
type
Limits the results to the metrics of the specified type. Possible values include the following:
  • discreteValued
  • continuousValued
  • count
group
Limits the results to the metrics within the specified group. Possible values include the following:
  • PingDirectory Server Backend
  • Monitoring Data Cache
  • Java Virtual Machine
  • LDAP
  • Entry Balancing
  • PingDirectory Server Entry Cache
  • External Server
  • Host System
  • Metric Query
  • Monitoring DBMS
  • Monitoring Data Processing
  • Replication
  • Sync Pipe
instanceType
Limits the result to metrics that uses the specified instance types as sources. Possible values include the following:
  • ds
  • proxy
  • sync
  • metrics-server
statistic
Limits the results to metrics that provides the specified statistics. Possible values include the following:
  • count
  • average
  • maximum
  • minimum
  • histogram
All metrics in JSON format.
curl \  
  -X GET \
  https://<metricsServerHost>:8080/api/v1/metrics.json
All count type metrics in the “PingDirectory Server Backend” group providing either count or average statistics:
curl \
  -X GET \
  https://<metricsServerHost>:8080/api/v1/metrics.json?type=count&group=ds
%20backend&statistic=count&statistic=average
Note:

Spaces in parameter values can be encoded as %20 or t.

Response Code

200 0K

Response Body

 
{
  "found": 7,
  "metrics": [
  {
  "countUnit": {
  "abbreviatedName": "Chkpt",
  "pluralName": "Checkpoints",
  "singularName": "Checkpoint"
  },
  "description": "Number of database checkpoints
  performed by the backend",
  "dimensions": [
  {
  "id": "backend",
  "values": [
  "userroot"
  ]
  }
  ],
  "group": "Directory Server Backend",
  "id": "backend-checkpoints",
  "instanceTypes": [
  "ds"
  ],
  "name": "Backend Checkpoints",
  "shortName": "Checkpoints",
  "statistics": [
  "count"
  ],
  "type": "count"
  },
  ...