Query a metric series
curl --request POST \
--url https://api.metal.ai/v1/data/metric-series \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <api-key>' \
--data '
{
"resource": "company:665f1c2a9b1e4a0012a3b4c5",
"key": "metric:revenue",
"dealContext": "<string>",
"policy": "<string>",
"period": {}
}
'import requests
url = "https://api.metal.ai/v1/data/metric-series"
payload = {
"resource": "company:665f1c2a9b1e4a0012a3b4c5",
"key": "metric:revenue",
"dealContext": "<string>",
"policy": "<string>",
"period": {}
}
headers = {
"x-metal-client-id": "<api-key>",
"x-metal-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-metal-client-id': '<api-key>',
'x-metal-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
resource: 'company:665f1c2a9b1e4a0012a3b4c5',
key: 'metric:revenue',
dealContext: '<string>',
policy: '<string>',
period: {}
})
};
fetch('https://api.metal.ai/v1/data/metric-series', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.metal.ai/v1/data/metric-series"
payload := strings.NewReader("{\n \"resource\": \"company:665f1c2a9b1e4a0012a3b4c5\",\n \"key\": \"metric:revenue\",\n \"dealContext\": \"<string>\",\n \"policy\": \"<string>\",\n \"period\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-metal-client-id", "<api-key>")
req.Header.Add("x-metal-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"resource": "<string>",
"key": "<string>",
"points": [
{}
]
}
}{
"error": "Invalid request body"
}{
"error": "invalid api key or clientId"
}Query a metric series
Returns a metric time series with advanced period and candidate filters.
POST
/
v1
/
data
/
metric-series
Query a metric series
curl --request POST \
--url https://api.metal.ai/v1/data/metric-series \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <api-key>' \
--data '
{
"resource": "company:665f1c2a9b1e4a0012a3b4c5",
"key": "metric:revenue",
"dealContext": "<string>",
"policy": "<string>",
"period": {}
}
'import requests
url = "https://api.metal.ai/v1/data/metric-series"
payload = {
"resource": "company:665f1c2a9b1e4a0012a3b4c5",
"key": "metric:revenue",
"dealContext": "<string>",
"policy": "<string>",
"period": {}
}
headers = {
"x-metal-client-id": "<api-key>",
"x-metal-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-metal-client-id': '<api-key>',
'x-metal-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
resource: 'company:665f1c2a9b1e4a0012a3b4c5',
key: 'metric:revenue',
dealContext: '<string>',
policy: '<string>',
period: {}
})
};
fetch('https://api.metal.ai/v1/data/metric-series', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.metal.ai/v1/data/metric-series"
payload := strings.NewReader("{\n \"resource\": \"company:665f1c2a9b1e4a0012a3b4c5\",\n \"key\": \"metric:revenue\",\n \"dealContext\": \"<string>\",\n \"policy\": \"<string>\",\n \"period\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-metal-client-id", "<api-key>")
req.Header.Add("x-metal-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"resource": "<string>",
"key": "<string>",
"points": [
{}
]
}
}{
"error": "Invalid request body"
}{
"error": "invalid api key or clientId"
}Authorizations
The Client ID of your API key.
The secret value of your API key.
Body
application/json
Response
The metric series.
Show child attributes
Show child attributes
Related topics
Get a metric seriesList available metricsGet an observationAPI referenceFinancial metrics⌘I

