← API Reference

Marketing API

Campaigns, newsletters, coupons, popups, CTAs, tracking

Base URL: https://marketing-api.ayoune.app — 60 entities

Example

cURL

curl -H "Authorization: Bearer pat_your_token" \
  https://marketing-api.ayoune.app/adcampaigns?limit=10

TypeScript SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

const result = await ay.marketing.adCampaigns.find().limit(10).exec();
console.log(result.payload());

Entities

Entity	REST Path	SDK	Access	Right
AdCampaigns	/adcampaigns	ay.marketing.adCampaigns	CRUD	marketing.adcampaigns	play_circle
AdGroups	/adgroups	ay.marketing.adGroups	CRUD	marketing.adgroups	play_circle
Advertisements	/advertisements	ay.marketing.advertisements	CRUD	marketing.advertisements	play_circle
aYOUneAdvertisementCampaigns	/ayouneadvertisementcampaigns	ay.marketing.aYOUneAdvertisementCampaigns	CRUD	marketing.ayouneadvertisementcampaigns	play_circle
aYOUneAdvertisementGroups	/ayouneadvertisementgroups	ay.marketing.aYOUneAdvertisementGroups	CRUD	marketing.ayouneadvertisementgroups	play_circle
Beacons	/beacons	ay.marketing.beacons	CRUD	marketing.beacons	play_circle
BeaconZones	/beaconzones	ay.marketing.beaconZones	CRUD	marketing.beaconzones	play_circle
CampaignClicks	/campaignclicks	ay.marketing.campaignClicks	read-only	marketing.campaignclicks	play_circle
Campaigns	/campaigns	ay.marketing.campaigns	CRUD	marketing.campaigns	play_circle
Channels	/channels	ay.marketing.channels	CRUD	marketing.channels	play_circle
ChatApps	/chatapps	ay.marketing.chatApps	CRUD	marketing.chatapps	play_circle
ChatWidgets	/chatwidgets	ay.marketing.chatWidgets	CRUD	marketing.chatwidgets	play_circle
Clicks	/clicks	ay.marketing.clicks	read-only	marketing.clicks	play_circle
CloudTags	/cloudtags	ay.marketing.cloudTags	CRUD	marketing.cloudtags	play_circle
CloudTagViews	/cloudtagviews	ay.marketing.cloudTagViews	read-only	marketing.cloudtagviews	play_circle
CloudTargets	/cloudtargets	ay.marketing.cloudTargets	CRUD	marketing.cloudtargets	play_circle
Collections	/collections	ay.marketing.collections	CRUD	marketing.collections	play_circle
CommunicationWidgets	/communicationwidgets	ay.marketing.communicationWidgets	CRUD	marketing.communicationwidgets	play_circle
Coupons	/coupons	ay.marketing.coupons	CRUD	marketing.coupons	play_circle
CTAs	/ctas	ay.marketing.cTAs	CRUD	marketing.ctas	play_circle
CustomerLogos	/customerlogos	ay.marketing.customerLogos	CRUD	marketing.customerlogos	play_circle
DesktopClients	/desktopclients	ay.marketing.desktopClients	CRUD	marketing.desktopclients	play_circle
DesktopNotifications	/desktopnotifications	ay.marketing.desktopNotifications	CRUD	marketing.desktopnotifications	play_circle
DMCampaigns	/dmcampaigns	ay.marketing.dMCampaigns	CRUD	marketing.dmcampaigns	play_circle
EmotionRatings	/emotionratings	ay.marketing.emotionRatings	CRUD	marketing.emotionratings	play_circle
Emotions	/emotions	ay.marketing.emotions	CRUD	marketing.emotions	play_circle
EventWidgets	/eventwidgets	ay.marketing.eventWidgets	CRUD	marketing.eventwidgets	play_circle
Experiments	/experiments	ay.marketing.experiments	CRUD	marketing.experiments	play_circle
FeedbackAnswers	/feedbackanswers	ay.marketing.feedbackAnswers	CRUD	marketing.feedbackanswers	play_circle
FeedbackQuestions	/feedbackquestions	ay.marketing.feedbackQuestions	CRUD	marketing.feedbackquestions	play_circle
Feedbacks	/feedbacks	ay.marketing.feedbacks	CRUD	marketing.feedbacks	play_circle
InteractionQuestionAnswers	/interactionquestionanswers	ay.marketing.interactionQuestionAnswers	CRUD	marketing.interactionquestionanswers	play_circle
InteractionQuestions	/interactionquestions	ay.marketing.interactionQuestions	CRUD	marketing.interactionquestions	play_circle
InterestBars	/interestbars	ay.marketing.interestBars	CRUD	marketing.interestbars	play_circle
KeywordNegativeLists	/keywordnegativelists	ay.marketing.keywordNegativeLists	CRUD	marketing.keywordnegativelists	play_circle
LinkPortals	/linkportals	ay.marketing.linkPortals	CRUD	marketing.linkportals	play_circle
LoyaltyPoints	/loyaltypoints	ay.marketing.loyaltyPoints	read-only	marketing.loyaltypoints	play_circle
LoyaltyPrograms	/loyaltyprograms	ay.marketing.loyaltyPrograms	CRUD	marketing.loyaltyprograms	play_circle
MeetingLocations	/meetinglocations	ay.marketing.meetingLocations	CRUD	marketing.meetinglocations	play_circle
Meetings	/meetings	ay.marketing.meetings	CRUD	marketing.meetings	play_circle
MeetingSpeakers	/meetingspeakers	ay.marketing.meetingSpeakers	CRUD	marketing.meetingspeakers	play_circle
MobileApps	/mobileapps	ay.marketing.mobileApps	CRUD	marketing.mobileapps	play_circle
MobileDevices	/mobiledevices	ay.marketing.mobileDevices	CRUD	marketing.mobiledevices	play_circle
Mouseovers	/mouseovers	ay.marketing.mouseovers	CRUD	marketing.mouseovers	play_circle
Newsletters	/newsletters	ay.marketing.newsletters	CRUD	marketing.newsletters	play_circle
NewsletterSnapshots	/newslettersnapshots	ay.marketing.newsletterSnapshots	CRUD	marketing.newslettersnapshots	play_circle
PopUps	/popups	ay.marketing.popUps	CRUD	marketing.popups	play_circle
Portfolios	/portfolios	ay.marketing.portfolios	CRUD	marketing.portfolios	play_circle
ProductRecommendations	/productrecommendations	ay.marketing.productRecommendations	CRUD	marketing.productrecommendations	play_circle
Publications	/publications	ay.marketing.publications	CRUD	marketing.publications	play_circle
PushNotifications	/pushnotifications	ay.marketing.pushNotifications	CRUD	marketing.pushnotifications	play_circle
Ratings	/ratings	ay.marketing.ratings	CRUD	marketing.ratings	play_circle
References	/references	ay.marketing.references	CRUD	marketing.references	play_circle
SeriesNewsletters	/seriesnewsletters	ay.marketing.seriesNewsletters	CRUD	marketing.seriesnewsletters	play_circle
ShortLinks	/shortlinks	ay.marketing.shortLinks	CRUD	marketing.shortlinks	play_circle
Slideshows	/slideshows	ay.marketing.slideshows	CRUD	marketing.slideshows	play_circle
UCDs	/ucds	ay.marketing.uCDs	CRUD	marketing.ucds	play_circle
UrlParams	/urlparams	ay.marketing.urlParams	CRUD	marketing.urlparams	play_circle
UserLinks	/userlinks	ay.marketing.userLinks	CRUD	marketing.userlinks	play_circle
WebPushSubscribers	/webpushsubscribers	ay.marketing.webPushSubscribers	CRUD	marketing.webpushsubscribers	play_circle