Definitions
Get the metric definitions
The definitions shown beside each number in the app, word for word. term finds one by key or name.
GET
/
definitions
curl
curl "https://api.citino.ai/v1/definitions" \
-H "Authorization: Bearer $CITINO_API_KEY"import os
import requests
res = requests.get(
"https://api.citino.ai/v1/definitions",
headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())const res = await fetch("https://api.citino.ai/v1/definitions", {
headers: {
Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
},
});
console.log(await res.json());{
"definitions": [
{
"key": "scope",
"term": "the scope",
"text": "Which questions, segments, days and AI engines the numbers on this screen are counted over. Change the filters and every number here changes with them."
},
{
"key": "sampleSize",
"term": "n",
"text": "How many answers a number is based on. The more answers, the more you can trust it."
},
{
"key": "margin",
"term": "±",
"text": "How far the true number could reasonably be from the one shown. It is wide when there are few answers or few questions behind it, and narrows as more come in."
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}⌘I
curl
curl "https://api.citino.ai/v1/definitions" \
-H "Authorization: Bearer $CITINO_API_KEY"import os
import requests
res = requests.get(
"https://api.citino.ai/v1/definitions",
headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())const res = await fetch("https://api.citino.ai/v1/definitions", {
headers: {
Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
},
});
console.log(await res.json());{
"definitions": [
{
"key": "scope",
"term": "the scope",
"text": "Which questions, segments, days and AI engines the numbers on this screen are counted over. Change the filters and every number here changes with them."
},
{
"key": "sampleSize",
"term": "n",
"text": "How many answers a number is based on. The more answers, the more you can trust it."
},
{
"key": "margin",
"term": "±",
"text": "How far the true number could reasonably be from the one shown. It is wide when there are few answers or few questions behind it, and narrows as more come in."
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"detail": {}
}
}