This post is also available in:
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.
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 internetowegoyour-api-key
– Klucz API Samba dla sklepu internetowegofrom, 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-mailexternal
– Jednorazowe kampanie e-mail – Kampanie zewnętrznefmcg
– Trigger cyklicznych zamówieńzsv
– Trigger intencji zakupowecart
– Trigger porzuconego koszykaapi
– API triggerflow
– Kampanie Flowpush
– Jednorazowe kampanie pushsms
– Jednorazowe kampanie SMS
- Każdy typ może zawierać następujące wskaźniki:
time
– kiedy kampania została wysłanatimestamp
– kiedy wysłano kampanięname
– nazwa kampaniiitemName
– 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 docelowejsent
– liczba wysłanych wiadomościdelivered
– liczba dostarczonych wiadomości (może być ustawiona automatycznie na 0)unsubscribed
– liczba rezygnacji z subskrypcji z powodu tej kampaniibounced
– miękkie odbiciadropped
– twarde odbiciacomplained
– oznaczone jako spamopened
– ile wiadomości było otwartychclicked
– ile wiadomości zostało klikniętychinteracted
– dla celów modelu atrybucji Samba.aideliveryRate
–delivered/sent
openRate
–opened/sent
clickThroughRate
–clicked/sent
unsubscribeRate
–unsubscribed/sent
utm_campaign
utm_source
utm_medium
custom_query_parameters
orders
– liczba przypisanych zamówień zgodnie z ustawioną metodą analizy konwersjirevenue
– suma przychodów według ustalonej metody analizy konwersjiaverageOrderValue
–revenue/orders
revenuePerEmail
–revenue/sent
conversionRateOverClicks
–orders/clicked
conversionRateOverInteractions
–orders/interacted
- wiadomości push (typ push, flow/push)
pushAudience
– całkowity rozmiar grupy docelowejpushSent
– liczba wysłanych wiadomościpushReceived
– liczba odebranych wiadomościpushThrottled
– liczba wiadomości (już niedawno skierowanych do klientów)pushFailed
– liczba nieudanych wiadomościpushClicked
– ile wiadomości zostało klikniętychpushClosed
– ile wiadomości zostało zamkniętychpushOrders
– liczba przypisanych zamówień zgodnie z ustawioną metodą analizy konwersjipushRevenue
– suma przychodów według ustalonej metody analizy konwersjipushAverageOrderValue
–pushRevenue
/pushOrders
pushConversionRateOverClicks
–pushOrders
/pushClicked
pushConversionRateOverInteractions
–pushOrders
/pushClicked
pushUtmCampaign
pushUtmMedium
pushUtmSource
- Wiadomości SMS
smsAudience
– całkowity rozmiar grupy docelowej odbiorcówsmsSent
– liczba wysłanych wiadomoścismsThrottled
– 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