Get a single metric
GET
/
v1
/
metrics
/
{id}
cURL
curl -X GET 'https://api.growthbook.io/api/v1/metrics/abc123' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/metrics/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growthbook.io/api/v1/metrics/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.growthbook.io/api/v1/metrics/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/metrics/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.growthbook.io/api/v1/metrics/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/metrics/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"metric": {
"id": "<string>",
"dateCreated": "<string>",
"dateUpdated": "<string>",
"owner": "<string>",
"datasourceId": "<string>",
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"projects": [
"<string>"
],
"archived": true,
"behavior": {
"windowSettings": {
"delayValue": 123,
"windowValue": 123
},
"riskThresholdSuccess": 123,
"riskThresholdDanger": 123,
"minPercentChange": 123,
"maxPercentChange": 123,
"minSampleSize": 123,
"targetMDE": 123,
"cappingSettings": {
"value": 123,
"ignoreZeros": true
},
"cap": 123,
"capValue": 123,
"priorSettings": {
"override": true,
"proper": true,
"mean": 123,
"stddev": 123
},
"conversionWindowStart": 123,
"conversionWindowEnd": 123
},
"ownerEmail": "<string>",
"sql": {
"identifierTypes": [
"<string>"
],
"conversionSQL": "<string>",
"userAggregationSQL": "<string>",
"denominatorMetricId": "<string>"
},
"sqlBuilder": {
"identifierTypeColumns": [
{
"identifierType": "<string>",
"columnName": "<string>"
}
],
"tableName": "<string>",
"valueColumnName": "<string>",
"timestampColumnName": "<string>",
"conditions": [
{
"column": "<string>",
"operator": "<string>",
"value": "<string>"
}
]
},
"mixpanel": {
"eventName": "<string>",
"eventValue": "<string>",
"userAggregation": "<string>",
"conditions": [
{
"property": "<string>",
"operator": "<string>",
"value": "<string>"
}
]
}
}
}Authorizations
bearerAuthbasicAuth
If using Bearer auth, pass the Secret Key as the token:
curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secret_abc123DEF456"
Path Parameters
The id of the requested resource
Response
200 - application/json
Successful response
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X GET 'https://api.growthbook.io/api/v1/metrics/abc123' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/metrics/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growthbook.io/api/v1/metrics/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.growthbook.io/api/v1/metrics/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/metrics/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.growthbook.io/api/v1/metrics/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/metrics/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"metric": {
"id": "<string>",
"dateCreated": "<string>",
"dateUpdated": "<string>",
"owner": "<string>",
"datasourceId": "<string>",
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"projects": [
"<string>"
],
"archived": true,
"behavior": {
"windowSettings": {
"delayValue": 123,
"windowValue": 123
},
"riskThresholdSuccess": 123,
"riskThresholdDanger": 123,
"minPercentChange": 123,
"maxPercentChange": 123,
"minSampleSize": 123,
"targetMDE": 123,
"cappingSettings": {
"value": 123,
"ignoreZeros": true
},
"cap": 123,
"capValue": 123,
"priorSettings": {
"override": true,
"proper": true,
"mean": 123,
"stddev": 123
},
"conversionWindowStart": 123,
"conversionWindowEnd": 123
},
"ownerEmail": "<string>",
"sql": {
"identifierTypes": [
"<string>"
],
"conversionSQL": "<string>",
"userAggregationSQL": "<string>",
"denominatorMetricId": "<string>"
},
"sqlBuilder": {
"identifierTypeColumns": [
{
"identifierType": "<string>",
"columnName": "<string>"
}
],
"tableName": "<string>",
"valueColumnName": "<string>",
"timestampColumnName": "<string>",
"conditions": [
{
"column": "<string>",
"operator": "<string>",
"value": "<string>"
}
]
},
"mixpanel": {
"eventName": "<string>",
"eventValue": "<string>",
"userAggregation": "<string>",
"conditions": [
{
"property": "<string>",
"operator": "<string>",
"value": "<string>"
}
]
}
}
}
