Revenue

Events associés : order.attributed

Endpoints

GET/v1/brands/{brand}/attribution
GET/v1/brands/{brand}/correlation
GET/v1/brands/{brand}/subscriptions
GET/v1/brands/{brand}/traffic
GET/v1/brands/{brand}/orders

L’objet Attribution

Attributs

objectstring
attribution
brandstring
La marque à laquelle l'objet appartient (br_…).
marketstring
Code du marché (pays ISO, par ex. FR).
periodstring
currencystringnullable
fromstringnullable
tostring
aiobjectnullable
Afficher les attributs enfants
- ordersstring
- revenuestring
- average_basketstring
- share_of_revenuestring
- share_of_ordersstring
- previous_ordersstring
- previous_revenuestring
- revenue_changestring
storeobjectnullable
Afficher les attributs enfants
- ordersstring
- revenuestring
- average_basketstring
surfacesarray of object
productsarray of object
first_touchobjectnullable
Orders the Skoup pixel joined to their visit: the buyer's first AI contact.
Afficher les attributs enfants
- window_daysstring
- ordersstring
- ai_ordersstring
- ai_sharestring
- ai_revenuestring
- surfacesarray of object
livemodeboolean
true pour les données réelles, false pour le bac à sable du mode test.

L'objet Attribution


{
  "object": "attribution",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "currency": "EUR",
  "from": "string",
  "to": "string",
  "ai": {
    "orders": "string",
    "revenue": "string",
    "average_basket": "string",
    "share_of_revenue": "string",
    "share_of_orders": "string",
    "previous_orders": "string",
    "previous_revenue": "string",
    "revenue_change": "string"
  },
  "store": {
    "orders": "string",
    "revenue": "string",
    "average_basket": "string"
  },
  "surfaces": [
    {}
  ],
  "products": [
    {}
  ],
  "first_touch": {
    "window_days": "string",
    "orders": "string",
    "ai_orders": "string",
    "ai_share": "string",
    "ai_revenue": "string",
    "surfaces": [
      {}
    ]
  },
  "livemode": true
}

L’objet Order

Attributs

idstring
Identifiant unique de l'objet (préfixé, opaque).
objectstring
order
sourceenum
The store an order was received from. Shopify today (orders/create webhook); WooCommerce / PrestaShop land here with their plugins.
Valeurs possibles : shopify
order_numberstringnullable
ordered_atstring
currencystring
subtotalstringnullable
totalstring
items_countinteger
countrystringnullable
ai_surfacestringnullable
Key of the AI surface the order is attributed to (chatgpt, claude, gemini, perplexity…), null = not attributed.
attribution_signalenumnullable
Which of the store's origin fields proved the AI surface of an order. NULL on the order = no AI signal (the referrer host is still kept). | | |---| | referrer <br/> The session's referrer is an assistant's domain. | | utm <br/> The landing URL carries a utm_source naming an assistant (ChatGPT tags its links). | | landing_ref <br/> Shopify's landing_site_ref (?ref=) names an assistant. |
Valeurs possibles : referrer · utm · landing_ref
referrer_hoststringnullable
landing_pathstringnullable
landing_productstringnullable
utm_sourcestringnullable
utm_mediumstringnullable
utm_campaignstringnullable
linesarray of object
Afficher les attributs enfants
- productstringnullable
  Null when the line matches no product of the catalogue.
- titlestring
- skustringnullable
- quantityinteger
- unit_pricestringnullable
- totalstring
livemodeboolean
true pour les données réelles, false pour le bac à sable du mode test.
createdinteger
Time at which the object was created (unix timestamp, seconds).

L'objet Order


{
  "id": "ord_031DIivuBKog78mwjgnaYz",
  "object": "order",
  "source": "shopify",
  "order_number": "#1042",
  "ordered_at": "2026-09-23T09:12:44Z",
  "currency": "EUR",
  "subtotal": "2399.00",
  "total": "2399.00",
  "items_count": 1,
  "country": "FR",
  "ai_surface": "chatgpt",
  "attribution_signal": "referrer",
  "referrer_host": "chatgpt.com",
  "landing_path": "/products/strade-7",
  "landing_product": "prod_031DIivuBKog78mwjgnbd3",
  "utm_source": null,
  "utm_medium": null,
  "utm_campaign": null,
  "lines": [
    {
      "product": "prod_031DIivuBKog78mwjgnbd3",
      "title": "Strade 7",
      "sku": "STR7-M",
      "quantity": 1,
      "unit_price": "2399.00",
      "total": "2399.00"
    }
  ],
  "livemode": true,
  "created": 1790154764
}

L’objet Visibility revenue correlation

Attributs

objectstring
visibility_revenue_correlation
brandstring
La marque à laquelle l'objet appartient (br_…).
marketstring
Code du marché (pays ISO, par ex. FR).
periodstring
categorystring
currencystringnullable
categoriesarray of object
weeksarray of object
fixesarray of object
livemodeboolean
true pour les données réelles, false pour le bac à sable du mode test.

L'objet Visibility revenue correlation


{
  "object": "visibility_revenue_correlation",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "category": "string",
  "currency": "EUR",
  "categories": [
    {}
  ],
  "weeks": [
    {}
  ],
  "fixes": [
    {}
  ],
  "livemode": true
}

L’objet Ai subscriptions

Attributs

objectstring
ai_subscriptions
brandstring
La marque à laquelle l'objet appartient (br_…).
marketstring
Code du marché (pays ISO, par ex. FR).
periodstring
fromstringnullable
tostringnullable
last_synced_atstring
currencystring
newobjectnullable
Afficher les attributs enfants
- subscriptionsstring
- mrrstring
- previous_subscriptionsstring
aiobjectnullable
Afficher les attributs enfants
- subscriptionsstring
- mrrstring
- share_of_subscriptionsstring
- share_of_mrrstring
- previous_subscriptionsstring
tracked_sharestring
surfacesarray of object
weeksarray of object
livemodeboolean
true pour les données réelles, false pour le bac à sable du mode test.

L'objet Ai subscriptions


{
  "object": "ai_subscriptions",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "from": "string",
  "to": "string",
  "last_synced_at": "2026-09-21T02:40:00Z",
  "currency": "EUR",
  "new": {
    "subscriptions": "string",
    "mrr": "string",
    "previous_subscriptions": "string"
  },
  "ai": {
    "subscriptions": "string",
    "mrr": "string",
    "share_of_subscriptions": "string",
    "share_of_mrr": "string",
    "previous_subscriptions": "string"
  },
  "tracked_share": "string",
  "surfaces": [
    {}
  ],
  "weeks": [
    {}
  ],
  "livemode": true
}

L’objet Ai traffic

Attributs

objectstring
ai_traffic
brandstring
La marque à laquelle l'objet appartient (br_…).
marketstring
Code du marché (pays ISO, par ex. FR).
periodstring
fromstringnullable
tostringnullable
last_hit_atstring
conversion_metricenumnullable
Valeurs possibles : transactions · key_events
aiobjectnullable
Afficher les attributs enfants
- sessionsstring
- transactionsstring
- key_eventsstring
- conversion_ratestring
- share_of_sessionsstring
- previous_sessionsstring
- sessions_changestring
siteobjectnullable
Afficher les attributs enfants
- sessionsstring
- transactionsstring
- key_eventsstring
- conversion_ratestring
surfacesarray of object
weeksarray of object
first_touchobjectnullable
Afficher les attributs enfants
- window_daysstring
- conversionsstring
- ai_conversionsstring
- ai_sharestring
- surfacesarray of object
livemodeboolean
true pour les données réelles, false pour le bac à sable du mode test.

L'objet Ai traffic


{
  "object": "ai_traffic",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "from": "string",
  "to": "string",
  "last_hit_at": "2026-09-21T02:40:00Z",
  "conversion_metric": "transactions",
  "ai": {
    "sessions": "string",
    "transactions": "string",
    "key_events": "string",
    "conversion_rate": "string",
    "share_of_sessions": "string",
    "previous_sessions": "string",
    "sessions_change": "string"
  },
  "site": {
    "sessions": "string",
    "transactions": "string",
    "key_events": "string",
    "conversion_rate": "string"
  },
  "surfaces": [
    {}
  ],
  "weeks": [
    {}
  ],
  "first_touch": {
    "window_days": "string",
    "conversions": "string",
    "ai_conversions": "string",
    "ai_share": "string",
    "surfaces": [
      {}
    ]
  },
  "livemode": true
}

Retrieve the AI attribution

GET/v1/brands/{brand}/attribution

Orders and revenue attributed to AI surfaces (ChatGPT, Claude, Gemini, Perplexity…) vs the whole store on a market over a period, by surface and by product — the figures of the Revenue screen. Attribution is last-touch, read from the store’s orders (referrer, utm_source, ref). Totals are null before the first order.

Paramètres

brandstringobligatoire
Brand id (br_…).

Retour

Renvoie l’objet attribution. Lève une erreur en cas de problème.

curl


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

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/attribution', {
  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/attribution', [
    '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/attribution",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Réponse


{
  "object": "attribution",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "currency": "EUR",
  "from": "string",
  "to": "string",
  "ai": {
    "orders": "string",
    "revenue": "string",
    "average_basket": "string",
    "share_of_revenue": "string",
    "share_of_orders": "string",
    "previous_orders": "string",
    "previous_revenue": "string",
    "revenue_change": "string"
  },
  "store": {
    "orders": "string",
    "revenue": "string",
    "average_basket": "string"
  },
  "surfaces": [
    {}
  ],
  "products": [
    {}
  ],
  "first_touch": {
    "window_days": "string",
    "orders": "string",
    "ai_orders": "string",
    "ai_share": "string",
    "ai_revenue": "string",
    "surfaces": [
      {}
    ]
  },
  "livemode": true
}

Retrieve the visibility ↔ revenue correlation

GET/v1/brands/{brand}/correlation

AI visibility and AI-attributed revenue side by side, week by week, with the fixes published each week — for the whole brand or one catalogue category. Visibility is given raw per model (hits / runs) plus the all-models share. weeks is empty until the store sent a first order.

Paramètres

brandstringobligatoire
Brand id (br_…).
categorystring

Retour

Renvoie l’objet visibility_revenue_correlation. Lève une erreur en cas de problème.

curl


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

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/correlation', {
  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/correlation', [
    '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/correlation",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Réponse


{
  "object": "visibility_revenue_correlation",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "category": "string",
  "currency": "EUR",
  "categories": [
    {}
  ],
  "weeks": [
    {}
  ],
  "fixes": [
    {}
  ],
  "livemode": true
}

Retrieve the AI subscriptions

GET/v1/brands/{brand}/subscriptions

New subscriptions and new MRR of a SaaS brand on a market over a period, read from its Stripe, and the part the AI assistants brought — as the brand records it in the customer’s or the subscription’s metadata (referrer, utm_source, landing_url). With the Growth plan or above, weeks puts the weekly AI visibility (raw counts per model) next to the new MRR. The blocks are null until Stripe is connected and synced; SaaS brands only.

Paramètres

brandstringobligatoire
Brand id (br_…).

Retour

Renvoie l’objet ai_subscriptions. Lève une erreur en cas de problème.

curl


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

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/subscriptions', {
  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/subscriptions', [
    '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/subscriptions",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Réponse


{
  "object": "ai_subscriptions",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "from": "string",
  "to": "string",
  "last_synced_at": "2026-09-21T02:40:00Z",
  "currency": "EUR",
  "new": {
    "subscriptions": "string",
    "mrr": "string",
    "previous_subscriptions": "string"
  },
  "ai": {
    "subscriptions": "string",
    "mrr": "string",
    "share_of_subscriptions": "string",
    "share_of_mrr": "string",
    "previous_subscriptions": "string"
  },
  "tracked_share": "string",
  "surfaces": [
    {}
  ],
  "weeks": [
    {}
  ],
  "livemode": true
}

Retrieve the AI traffic

GET/v1/brands/{brand}/traffic

Sessions and conversions the AI assistants (ChatGPT, Claude, Gemini, Perplexity…) send to the site, per surface and per week, vs the whole site — measured by the Skoup script installed on it, the figures of the « AI traffic » screen — and the conversions whose first touch was an assistant. The blocks are null until the script brought a visit.

Paramètres

brandstringobligatoire
Brand id (br_…).

Retour

Renvoie l’objet ai_traffic. Lève une erreur en cas de problème.

curl


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

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/traffic', {
  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/traffic', [
    '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/traffic",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Réponse


{
  "object": "ai_traffic",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "90d",
  "from": "string",
  "to": "string",
  "last_hit_at": "2026-09-21T02:40:00Z",
  "conversion_metric": "transactions",
  "ai": {
    "sessions": "string",
    "transactions": "string",
    "key_events": "string",
    "conversion_rate": "string",
    "share_of_sessions": "string",
    "previous_sessions": "string",
    "sessions_change": "string"
  },
  "site": {
    "sessions": "string",
    "transactions": "string",
    "key_events": "string",
    "conversion_rate": "string"
  },
  "surfaces": [
    {}
  ],
  "weeks": [
    {}
  ],
  "first_touch": {
    "window_days": "string",
    "conversions": "string",
    "ai_conversions": "string",
    "ai_share": "string",
    "surfaces": [
      {}
    ]
  },
  "livemode": true
}

List AI-attributed orders

GET/v1/brands/{brand}/orders

The store orders attributed to an AI surface, newest first. Test orders are excluded; no customer data is ever returned.

Paramètres

brandstringobligatoire
Brand id (br_…).
surfacestring
countrystring
limitinteger
Nombre d'objets à renvoyer, entre 1 et 100 (20 par défaut).
starting_afterstring
Curseur : l'id du dernier objet de la page précédente.

Retour

Un dictionnaire dont la propriété data contient jusqu’à limit objets order, du plus récent au plus ancien, et has_more indique s’il reste une page. Lève une erreur en cas de problème.

curl


curl https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/orders?limit=3 \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/orders?limit=3', {
  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/orders?limit=3', [
    '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/orders?limit=3",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Réponse


{
  "object": "list",
  "url": "/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/orders",
  "has_more": false,
  "data": [
    {
      "id": "ord_031DIivuBKog78mwjgnaYz",
      "object": "order",
      "source": "shopify",
      "order_number": "#1042",
      "ordered_at": "2026-09-23T09:12:44Z",
      "currency": "EUR",
      "subtotal": "2399.00",
      "total": "2399.00",
      "items_count": 1,
      "country": "FR",
      "ai_surface": "chatgpt",
      "attribution_signal": "referrer",
      "referrer_host": "chatgpt.com",
      "landing_path": "/products/strade-7",
      "landing_product": "prod_031DIivuBKog78mwjgnbd3",
      "utm_source": null,
      "utm_medium": null,
      "utm_campaign": null,
      "lines": [
        {
          "product": "prod_031DIivuBKog78mwjgnbd3",
          "title": "Strade 7",
          "sku": "STR7-M",
          "quantity": 1,
          "unit_price": "2399.00",
          "total": "2399.00"
        }
      ],
      "livemode": true,
      "created": 1790154764
    }
  ]
}