Skip to content
Dixa API/
/
Metric Description

Metric Description

Request

This endpoint lists all available properties of a metric to use for querying its data

Security
ApiKeyAuth
Path
metricIdstringrequired
GET
/v1/analytics/metrics/{metricId}
curl -i -X GET \
  'https://dev.dixa.io/v1/analytics/metrics/{metricId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The metric properties

Bodyapplication/json
dataobject(MetricMetadata)required
Response
{
  "data": {
    "id": "csat",
    "description": "(Number of satisfied customers (4 and 5)/ Number of survey responses) x 100 = % of satisfied customers",
    "filters": [ … ],
    "aggregations": [ … ],
    "relatedRecordIds": [ … ]
  }
}