Info

icon	false
title	Table of Contents

Table of Contents

maxLevel	1

Get a List of Metrics

Use Case	Example Request
Get all the metrics from the Sonar Nemo instance	GET http://nemo.sonarsource.org/api/metrics
Get the metric 'Lines of Code' (id = ncloc)	GET http://nemo.sonarsource.org/api/metrics/ncloc

...

Parameter	Description	Required	Default Value	Example Value
id	id or key of the metric	No. Get all metrics if not set	None	ncloc
format	Response format. Possible values: xml \| json	No	None	json

Create a Metric

Description	Create a metric
URL	/api/metrics
HTTP Method	POST
Security	Requires Global Administrator role

Use Case	Example Request
Create a metric	?Q?

Parameter	Description	Required	Default Value	Example Value
description	Description of the metric		None	My metric blabla
direction	Possible values: -1 \| 0 \| 1		None	-1
domain	Domain of the metric		None	Size
name	Name of the metric	Yes	None	myMetric
qualitative	Is it a qualitative metric? Possible values: 0 \| 1		None	1
val_type	Value type. Possible values: PERCENT \| INT \| FLOAT \| STRING \| BOOL \| MILLISEC	Yes	None	PERCENT
user_defined	Can user fill measures online? Possible values: true \| false	No	false	true

Description	Update a metric
URL	/api/metrics
HTTP Method	PUT
Security	Requires Global Administrator role

Use Case	Example Request
Create a metric	?Q?

?Q?

...

Description	Delete a metric
URL	/api/metrics
HTTP Method	DELETE
Security	Requires Global Administrator role

Use Case	Example Request
Delete metric 'myMetric'	curl -u admin:admin -X DELETE http://localhost:9000/api/metrics/myMetric

Parameter	Description	Required	Default Value	Example Value
id	id of the metric	Yes	None	myMetric