ADadhook
Promotion

GET /v1/promotions/calendar

Changed on

Request

  • Base URL
    https://app.adhook.io (the document declares no server; this is the origin it was published from)
  • URL
    https://app.adhook.io/v1/promotions/calendar
  • Auth
    none declared

Query parameters

promotionStatus'ALL' | 'DRAFT' | 'PLANNED' | 'IN_PROGRESS' | 'STOPPED' | 'IN_REVIEW' | 'COMPLETED'
promotionType'ALL' | 'TRAFFIC' | 'CONVERSIONS' | 'RETARGETING' | 'SHOPPING' | 'APP' | 'ENGAGEMENT' | 'VIDEO_VIEWS' | 'CALLS' | 'REACH' | 'FOLLOWERS' | 'PROFILE_VIEWS' | 'LEADS' | 'PERFORMANCE_MAX' | 'SMART'
startstring
endstring
subtenantIdstring
subtenantIdsstring[]
groupIdstring
tagIdsstring[]
tagIdsGroup2string[]
tagIdsGroup3string[]
topicIdsstring[]
channelsstring[]
categorystring

Response

default response

idstring
titlestring
type'TRAFFIC' | 'CONVERSIONS' | 'RETARGETING' | 'SHOPPING' | 'CARS' | 'REAL_ESTATE' | 'JOBS' | 'EVENTS' | 'APP' | 'ENGAGEMENT' | 'VIDEO_VIEWS' | 'CALLS' | 'REACH' | 'FOLLOWERS' | 'PROFILE_VIEWS' | 'LEADS' | 'PERFORMANCE_MAX' | 'DEMAND_GEN' | 'SMART'
status'CREATED' | 'READY' | 'PLANNED' | 'BLOCKED' | 'IN_PROGRESS' | 'COMPLETED' | 'DELETED' | 'STOPPED' | 'ERROR' | 'ACTIVATING' | 'IMPORTING' | 'READY_FOR_PAYMENT' | 'IN_REVIEW' | 'LOCKED' | 'PRODUCT_SYNCHRONIZING' | 'CHECK_REVIEW_FEEDBACK'
colorstring
createdAtstring date-time
createdByUserEmailstring
subtenantIdstring
createdByUserIdstring
tenantIdstring
totalCostnumber double
startstring date-time
endstring date-time
nbrOfDaysinteger
durationType'SHORT_TERM' | 'LONG_TERM'
versioninteger
impressionsinteger
clicksinteger
costnumber double
netCostnumber double
conversionsnumber double
conversionValuenumber double
ctrnumber double
cpcnumber double
cpmnumber double
reactionsinteger
importOrigin'GOOGLE_ADWORDS' | 'FACEBOOK' | 'LINKED_IN' | 'TWITTER' | 'TIKTOK' | 'PINTEREST'
mode'SIMPLE' | 'EXTENDED' | 'EXPERT'
source'TARGETING_TOOL' | 'TEMPLATE' | 'LEAD_CHATBOT' | 'GENERATION'
processReviewFeedbackstring
activationErrorMessagestring
activationErrorChannel'FACEBOOK' | 'INSTAGRAM' | 'GOOGLE_ADWORDS' | 'GOOGLE_DISPLAY_NETWORK' | 'GOOGLE_ANALYTICS' | 'YOUTUBE' | 'XING' | 'LINKED_IN' | 'TWITTER' | 'GOOGLE_MY_BUSINESS' | 'TIKTOK' | 'BITLY' | 'THREADS' | 'BLUESKY' | 'WHATSAPP' | 'PINTEREST' | 'CANVA' | 'HUBSPOT' | 'SALESFORCE' | 'BREVO' | 'SISTRIX' | 'NEWS' | 'BEEKEEPER' | 'TEADS' | 'MASTODON' | 'SNAPCHAT' | 'PIXXIO' | 'YEXT' | 'CANTO' | 'WEBSITE' | 'PLAUSIBLE' | 'MATOMO'
activationStatus'PENDING' | 'ERROR' | 'COMPLETED'
processTaskAssigneeUserIdstring
processTaskAssigneeUserIdsstring[]

Changes

  • 7a8a196e5eddRevision changes
    • warning

      deleted the header request parameter Authorization

    • warning

      deleted the header request parameter adhookToken

  • 0dc45becb980Revision changes
    • warning

      added the new INFLUENCER enum value to the /// response property for the response status