Skip to main content
GET
/
prod
/
site
/
{idSite}
/
welcome
Get Welcome Campaign
curl --request GET \
  --url https://api.aimtell.com/prod/site/{idSite}/welcome \
  --header 'X-Authorization-Api-Key: <api-key>'
{
  "id": 1234,
  "title": "Sample Welcome Campaign",
  "body": "Thanks for joining us!",
  "link": "{website_url}",
  "customImage": "",
  "customIcon": "https://cdn.aimtell.io/user/uploads/12345-1588183932.png",
  "idSite": 20599,
  "status": 1,
  "conversion_trigger": {
    "eventCategory": "Page",
    "eventAction": "Visited",
    "eventLabel": ""
  },
  "actions": {
    "a01": {
      "title": "Get the best deals!",
      "link": "{website_url}"
    },
    "a02": {
      "title": "Check out our blog!",
      "link": "{website_url}/blog"
    }
  },
  "createdAt": "2020-04-29 18:12:57",
  "updatedAt": "2020-12-18 16:15:40",
  "campaign_results": {
    "sent": 13,
    "delivered": 13,
    "bounced": 0,
    "clicked": 5,
    "clicked_a01": 0,
    "clicked_a02": 0,
    "conversions": 1
  }
}

Authorizations

X-Authorization-Api-Key
string
header
default:""
required

Path Parameters

idSite
string
required

Website ID

Response

200