Brand profile
List attributes
The attributes AI engines attach to the project’s brand and to compared competitors, with each brand’s strength and the gap between them in points, each brand’s strength on eight fixed dimensions, and whose each attribute is. Only grouped attributes are listed.
GET
/
projects
/
{projectId}
/
attributes
curl
curl "https://api.citino.ai/v1/projects/{projectId}/attributes" \
-H "Authorization: Bearer $CITINO_API_KEY"import os
import requests
res = requests.get(
"https://api.citino.ai/v1/projects/{projectId}/attributes",
headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/attributes", {
headers: {
Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
},
});
console.log(await res.json());{
"state": "<string>",
"scope": {
"window": "<string>",
"from": "<string>",
"to": "<string>",
"read": 0,
"answers": 0,
"skipped": 0
},
"own": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"own": true
},
"compared": [
{
"brand": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"own": true
},
"answers": 0,
"against": [
{
"key": "<string>",
"label": "<string>",
"dimension": "ease_of_use",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
}
}
]
}
],
"dimensions": [
{
"dimension": "ease_of_use",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"gaps": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"gap": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
}
}
]
}
],
"items": [
{
"key": "<string>",
"label": "<string>",
"polarity": "positive",
"dimension": "ease_of_use",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"engines": [
"<string>"
],
"gaps": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"gap": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"standing": "yours"
}
]
}
],
"drift": [
{
"engine": "<string>",
"occurred_on": "<string>"
}
]
}{
"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": {}
}
}Authorizations
An API key from Workspace settings → API keys, sent as Authorization: Bearer <key>.
Path Parameters
Query Parameters
Available options:
7d, 30d, 90d, 180d, 365d, custom Pattern:
^\d{4}-\d{2}-\d{2}$Pattern:
^\d{4}-\d{2}-\d{2}$Up to three brand ids, comma-separated, each a tracked competitor of the project. Defaults to the most visible one.
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The own brand's strength on each of eight fixed dimensions (the share of answers naming it that attach a positive or neutral attribute of the dimension), and each compared brand's strength and the gap in points.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
curl
curl "https://api.citino.ai/v1/projects/{projectId}/attributes" \
-H "Authorization: Bearer $CITINO_API_KEY"import os
import requests
res = requests.get(
"https://api.citino.ai/v1/projects/{projectId}/attributes",
headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/attributes", {
headers: {
Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
},
});
console.log(await res.json());{
"state": "<string>",
"scope": {
"window": "<string>",
"from": "<string>",
"to": "<string>",
"read": 0,
"answers": 0,
"skipped": 0
},
"own": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"own": true
},
"compared": [
{
"brand": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"own": true
},
"answers": 0,
"against": [
{
"key": "<string>",
"label": "<string>",
"dimension": "ease_of_use",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
}
}
]
}
],
"dimensions": [
{
"dimension": "ease_of_use",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"gaps": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"gap": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
}
}
]
}
],
"items": [
{
"key": "<string>",
"label": "<string>",
"polarity": "positive",
"dimension": "ease_of_use",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"engines": [
"<string>"
],
"gaps": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strength": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"gap": {
"value": 123,
"unit": "percent",
"band": 123,
"n": 0,
"delta": 123,
"within_noise": true,
"low_sample": true,
"state": "measured",
"note": "<string>"
},
"standing": "yours"
}
]
}
],
"drift": [
{
"engine": "<string>",
"occurred_on": "<string>"
}
]
}{
"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": {}
}
}