1. Home
  2. Extra
  3. Samba API
  4. Export Dashboard
Searching...

Export Dashboard

Contents

This post is also available in: Czech

If you want to create automatic reports in your internal CRM system, you can gather data from the Samba dashboard via API.

Please ask us for the API key via email.

Rate limits

It is allowed to ask for a maximum period of 6 months. Requests for longer periods of time may lead to blocking.

Endpoint URL

Depending on your account, select the appropriate endpoint URL.

  • If you are logging in at app.samba.ai –> choose the URL api.samba.ai
  • If you are logging in at enterprise.samba.ai –> choose the URL api.yottly.com

Your account ID can be found in the Settings section as part of your unique tracking script.

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 – Samba ID of your e-shop
  • your-api-key – Samba API key for your e-shop
  • from, to
    • Complete date in YYYY-MM-DDThh:mm:ssTZD format (ISO8601) or UTC timestamp (milliseconds since 1970-01-01).
    • When providing only date, time is set to 00:00 at Europe/Prague timezone.
    • You may provide time and timezone, e.g. "from": "2016-09-01T05:00+0200", "from": "2016-09-01T12:00Z".
    • To use default time (midnight), just provide timezone info after empty date/time delimiter e.g. "2016-09-01T-04" for EDT midnight.

RESPONSE

  • JSON format (application/json)
  • Results are grouped by the type label:
    • internal – One-off email campaigns
    • external – One-off email campaigns – External campaigns
    • fmcg – Repeated orders trigger
    • zsv – Shopping intention trigger
    • cart – Abandoned cart trigger
    • api – API trigger
    • flow – Flow campaigns
    • push – One-off push campaigns
    • sms – One-off SMS campaigns
  • Each type can include following metrics:
    • time – when the campaign was sent
    • timestamp – when the campaign was sent
    • name – name of the campaign
    • itemName – name of the campaign item (if available)
    • email messages  (type internal, external, fmcg, zsv, cart, api, flow/email)
      • total – total size of the audience to be targeted
      • sent – number of sent messages
      • delivered – number of delivered messages (can be set automatically to 0)
      • unsubscribed – number of unsubscribes due to this campaign
      • bounced – soft bounces
      • dropped – hard bounces
      • complained – marked as spam
      • opened – how many messages were open
      • clicked – how many messages were clicked-through
      • interacted – for Samba.ai attribution model purposes
      • deliveryRate – delivered/sent
      • openRate – opened/sent
      • clickThroughRate – clicked/sent
      • unsubscribeRate – unsubscribed/sent
      • utm_campaign 
      • utm_source 
      • utm_medium 
      • custom_query_parameters
      • orders – number of attributed orders according to set Conversion Analysis Method
      • revenue – sum of the revenue according to set Conversion Analysis Method
      • averageOrderValue – revenue/orders
      • revenuePerEmail – revenue/sent
      • conversionRateOverClicks – orders/clicked
      • conversionRateOverInteractions – orders/interacted
    • push messages  (type  push, flow/push)
      • pushAudience – total size of the audience to be targeted
      • pushSent – number of sent messages
      • pushReceived – number of received messages
      • pushThrottled – number of throttled messages (already recently targeted customers)
      • pushFailed – number of failed messages
      • pushClicked– how many messages were clicked-through
      • pushClosed – how many messages were closed
      • pushOrders – number of attributed orders according to set Conversion Analysis Method
      • pushRevenue – sum of the revenue according to set Conversion Analysis Method
      • pushAverageOrderValue – pushRevenue/pushOrders
      • pushConversionRateOverClicks – pushOrders/pushClicked
      • pushConversionRateOverInteractions – pushOrders/pushClicked
      • pushUtmCampaign
      • pushUtmMedium
      • pushUtmSource
    • SMS messages
      • smsAudience – total size of the audience to be targeted
      • smsSent – number of sent messages
      • smsThrottled – number of throttled messages (already recently targeted customers)
      • smsFailed – number of failed messages

EXAMPLE

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: Czech

Updated on January 13, 2025

Was this article helpful?

Yes No

Related Articles