Sign in
Statistic - Ad

put/v1/promotions/{id}/adStatistic/{adStatisticId}/status

Path parameters

idstring required
adStatisticIdstring required

Headers

adhookTokenstring
Authorizationstring

Response

default response

status'IS_RUNNING' | 'STOP' | 'IN_REVIEW' | 'REMOVED' | 'COMPLETED' | 'DISAPPROVED' | 'IS_STOPPING'
idstring
adIdstring
adNamestring
impressionsinteger
clicksinteger
conversionsnumber double
leadsnumber double
conversionValuenumber double
allConversionsnumber double
averagePositionnumber double
cpcnumber double
cpmnumber double
cpanumber double
cplnumber double
ctrnumber double
totallySpentnumber double
promotionIdstring
currency'CHF' | 'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XSU' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
targetIdstring
targetNamestring
placement'GOOGLE_SEARCH_NETWORK' | 'FACEBOOK_TIMELINE' | 'GOOGLE_DISPLAY_NETWORK' | 'FACEBOOK_AUDIENCE_NETWORK' | 'YOUTUBE' | 'INSTAGRAM_TIMELINE' | 'GOOGLE_SHOPPING' | 'FACEBOOK_MESSENGER' | 'LINKEDIN_CONTENT' | 'LINKEDIN_TEXT' | 'LINKEDIN_INMAIL' | 'LINKEDIN_DYNAMIC' | 'FACEBOOK_STORIES' | 'FACEBOOK_INSTANT_ARTICLES' | 'FACEBOOK_RIGHT_HAND_COLUMN' | 'FACEBOOK_MARKETPLACE' | 'INSTAGRAM_STORIES' | 'FACEBOOK_MESSENGER_STORIES' | 'FACEBOOK_SEARCH' | 'FACEBOOK_INSTREAM_VIDEO' | 'FACEBOOK_REELS' | 'INSTAGRAM_EXPLORE_HOME' | 'INSTAGRAM_PROFILE_FEED' | 'INSTAGRAM_PROFILE_REELS' | 'LINKEDIN_AUDIENCE_NETWORK' | 'TWITTER_ALL' | 'TWITTER_PUBLISHER_NETWORK' | 'TWITTER_SEARCH' | 'TWITTER_TIMELINE' | 'TWITTER_PROFILE' | 'GOOGLE_MY_BUSINESS' | 'FACEBOOK_UNKNOWN' | 'FACEBOOK_VIDEO_FEED' | 'INSTAGRAM_REELS' | 'INSTAGRAM_SHOP' | 'INSTAGRAM_EXPLORE' | 'TIKTOK_FEED' | 'META_AUTOMATIC' | 'THREADS_FEED' | 'BLUESKY_FEED' | 'PINTEREST_FEED'
adgroupIdstring
adgroupNamestring
internalAdGroupIdstring
productOfferIdstring
productCategoriesstring[]
productTypesstring[]
productBrandstring
feedItemIdstring
frequencynumber double
relevanceScoreinteger
retweetsinteger
likesinteger
followsinteger
reachinteger
totalReachinteger
postClicksinteger
postReactionsinteger
postEngagementsinteger
commentsinteger
linkClicksinteger
costPerLinkClicknumber double
linkClickCtrnumber double
landingPageViewsinteger
videoViewsinteger
video25PercentCompletionsinteger
video50PercentCompletionsinteger
video75PercentCompletionsinteger
videoCompletionsinteger
messageSendsinteger
messageOpensinteger
messageOpenRatenumber double
thumbstopRatenumber double
videoCompletionRatenumber double
thruplaysinteger
videoWatched6sinteger
engagedView15sinteger
costPerThruplaynumber double
nbrOfSessionsinteger
averageSessionDurationinteger
bounceRatenumber double
usersinteger
newUsersinteger
pageViewsPerSessionnumber double
engagedSessionsinteger
screenPageViewsinteger
absoluteTopImpressionPercentagenumber double
topImpressionPercentagenumber double
disapprovedReasonTextstring
resultsnumber double
costPerResultnumber double
costnumber double
reactionsinteger
callsinteger

Changes

Changed in 5 of the 9 revisions of this API.642

  • 1fc844ab59a12See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 6b7ccc7e265141See the full diff
    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 10ee593749b32See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 802e871d48ca1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 1c8b6833fbae2See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added