Metrics

Endpoints

GET/v1/brands/{brand}/metrics

The Brand metrics object

Attributes

objectstring
brand_metrics
brandstring
The brand the object belongs to (br_…).
marketstring
Market code (ISO country, e.g. FR).
periodstring
visibilitystring
accuracystring
readinessstring
perceptionstring
livemodeboolean
true for live data, false for the test-mode sandbox.

The Brand metrics object


{
  "object": "brand_metrics",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "visibility": "string",
  "accuracy": "string",
  "readiness": "string",
  "perception": "string",
  "livemode": true
}

Retrieve brand metrics

GET/v1/brands/{brand}/metrics

The headline numbers of a brand on a market over a period — the same figures as the app’s screens: share of the AI answers citing the brand (share of shelf) with its 95 % interval and week-over-week change, accuracy of the price and availability claims, AI readiness score and perception score. A block never measured is null, never zeros.

Parameters

brandstringrequired
Brand id (br_…).

Returns

Returns the brand_metrics object. Raises an error if something goes wrong.

curl


curl https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/metrics \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/metrics', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
  },
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('GET', 'brands/br_034CyfRFSXUqzrbzV6MAfZ/metrics', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.get(
    "https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/metrics",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Response


{
  "object": "brand_metrics",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "visibility": "string",
  "accuracy": "string",
  "readiness": "string",
  "perception": "string",
  "livemode": true
}