Export pulpitu

Spis treści

This post is also available in: Czeski Angielski

Jeśli chcesz tworzyć automatyczne raporty w swoim wewnętrznym systemie CRM, możesz zbierać dane z pulpitu Samby za pośrednictwem interfejsu API.

Poproś nas o klucz API mailowo.

Limity dat

Dozwolone jest wnioskowanie o maksymalny okres 6 miesięcy. Prośby o dłuższe okresy mogą prowadzić do blokady.

URL punktu końcowego

W zależności od konta wybierz odpowiedni adres URL punktu końcowego.

  • Jeśli logujesz się na app.samba.ai –> wybierz adres URL api.samba.ai
  • Jeśli logujesz się na stronie enterprise.samba.ai –> wybierz adres URL api.yottly.com

Identyfikator konta można znaleźć w sekcji Ustawienia -> Trackpoint ID

GET

https://api.samba.ai/shop/sambaId/dashboard/json?from=YYYY-MM-DDThh:mm:ssTZD
&to=YYYY-MM-DDThh:mm:ssTZD
header: X-Api-Key: your-api-key
  • sambaId – ID Samby sklepu internetowego
  • your-api-key – Klucz API Samba dla sklepu internetowego
  • from, to
    • Pełna data w formacie RRRR-MM-DDThh:mm:ssTZD (ISO8601) lub znacznik czasu UTC (milisekundy od 1970-01-01).
    • Jeśli podana jest tylko data, czas jest ustawiony na 00:00 w europejskiej/praskiej strefie czasowej.
    • Możesz podać czas i strefę czasową, np. "from": "2016-09-01T05:00+0200", "from": "2016-09-01T12:00Z".
    • Aby użyć domyślnego czasu (północ), wystarczy podać informacje o strefie czasowej po pustym ograniczniku daty/czasu, np. "2016-09-01T-04" dla północy EDT.

ODPOWIEDŹ

  • Format JSON (application/json)
  • Wyniki są pogrupowane według etykiety typu:
    • internal – Jednorazowe kampanie e-mail
    • external – Jednorazowe kampanie e-mail – Kampanie zewnętrzne
    • fmcg – Trigger cyklicznych zamówień
    • zsv – Trigger intencji zakupowe
    • cart – Trigger porzuconego koszyka
    • api – API trigger
    • flow – Kampanie Flow
    • push – Jednorazowe kampanie push
    • sms – Jednorazowe kampanie SMS
  • Każdy typ może zawierać następujące wskaźniki:
    • time – kiedy kampania została wysłana
    • timestamp – kiedy wysłano kampanię
    • name – nazwa kampanii
    • itemName – nazwa elementu kampanii (jeśli jest dostępna)
    • wiadomości e-mail (typ wewnętrzny, zewnętrzny, fmcg, zsv, cart, api, flow/email)
      • total – całkowity rozmiar grupy docelowej
      • sent – liczba wysłanych wiadomości
      • delivered – liczba dostarczonych wiadomości (może być ustawiona automatycznie na 0)
      • unsubscribed – liczba rezygnacji z subskrypcji z powodu tej kampanii
      • bounced – miękkie odbicia
      • dropped – twarde odbicia
      • complained – oznaczone jako spam
      • opened – ile wiadomości było otwartych
      • clicked – ile wiadomości zostało klikniętych
      • interacted – dla celów modelu atrybucji Samba.ai
      • deliveryRatedelivered/sent
      • openRateopened/sent
      • clickThroughRateclicked/sent
      • unsubscribeRateunsubscribed/sent
      • utm_campaign 
      • utm_source 
      • utm_medium 
      • custom_query_parameters
      • orders – liczba przypisanych zamówień zgodnie z ustawioną metodą analizy konwersji
      • revenue – suma przychodów według ustalonej metody analizy konwersji
      • averageOrderValuerevenue/orders
      • revenuePerEmailrevenue/sent
      • conversionRateOverClicksorders/clicked
      • conversionRateOverInteractionsorders/interacted
    • wiadomości push (typ push, flow/push)
      • pushAudience – całkowity rozmiar grupy docelowej
      • pushSent – liczba wysłanych wiadomości
      • pushReceived – liczba odebranych wiadomości
      • pushThrottled – liczba wiadomości (już niedawno skierowanych do klientów)
      • pushFailed – liczba nieudanych wiadomości
      • pushClicked– ile wiadomości zostało klikniętych
      • pushClosed – ile wiadomości zostało zamkniętych
      • pushOrders – liczba przypisanych zamówień zgodnie z ustawioną metodą analizy konwersji
      • pushRevenue – suma przychodów według ustalonej metody analizy konwersji
      • pushAverageOrderValuepushRevenue/pushOrders
      • pushConversionRateOverClickspushOrders/pushClicked
      • pushConversionRateOverInteractionspushOrders/pushClicked
      • pushUtmCampaign
      • pushUtmMedium
      • pushUtmSource
    • Wiadomości SMS
      • smsAudience – całkowity rozmiar grupy docelowej odbiorców
      • smsSent – liczba wysłanych wiadomości
      • smsThrottled – liczba wiadomości (już niedawno skierowanych do klientów)
      • smsFailed – liczba nieudanych wiadomości

Przykład

curl -s -H "X-Api-Key: your-api-key" 'https://api.yottly.com/shop/123456789/dashboard/json?from=1735739438000&to=1736779840000' | jq -C . | less -RS

This post is also available in: Czeski Angielski

Zaktualizowano na 5 maja, 2025

Czy ten artykuł był pomocny?

Artykuły powiązane