Sign in
Statistic - Ad

get/v1/promotions/{id}/adStatistic

Path parameters

idstring required

Query parameters

skipinteger
limitinteger
sortBystring
sortDirectioninteger
startstring
endstring
fetchMode'AGGREGATED' | 'DAILY'
statusFilter'ALL' | 'ACTIVE'

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 4 of the 8 revisions of this API.442

  • 6b7ccc7e265141See the full diff
    • ○

      added the optional property items/adVariation/slides/items/video/audioCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/bitrateBps to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/compressedVideoUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/duration to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/hasAudio to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/justOptimized to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/metadataStatus to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/originalSize to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/originalUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/slides/items/video/videoCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/audioCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/bitrateBps to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/compressedVideoUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/duration to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/hasAudio to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/justOptimized to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/metadataStatus to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/originalSize to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/originalUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/verticalVideo/videoCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/audioCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/bitrateBps to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/compressedVideoUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/duration to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/hasAudio to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/justOptimized to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/metadataStatus to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/originalSize to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/originalUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/video/videoCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/audioCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/bitrateBps to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/compressedVideoUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/duration to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/hasAudio to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/justOptimized to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/metadataStatus to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/originalSize to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/originalUrl to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/adVariation/videos/items/videoCodec to the response with the default status

      response-optional-property-added

    • ○

      added the optional property items/dailyStatistic/items/snapchatFollowers to the response with the default status

      response-optional-property-added

  • 10ee593749b32See the full diff
    • ●

      added the new YEXT enum value to the items/dailyStatistic/items/channelStatistics/items/channel response property for the response status default

      response-property-enum-value-added

    • ●

      added the new YEXT enum value to the items/dailyStatistic/items/deviceStatistics/items/channel response property for the response status default

      response-property-enum-value-added

  • 802e871d48ca1See the full diff
    • ○

      added the optional property items/adVariation/youTubePostId to the response with the default status

      response-optional-property-added

  • 1c8b6833fbae2See the full diff
    • ●

      added the new CANTO enum value to the items/dailyStatistic/items/channelStatistics/items/channel response property for the response status default

      response-property-enum-value-added

    • ●

      added the new CANTO enum value to the items/dailyStatistic/items/deviceStatistics/items/channel response property for the response status default

      response-property-enum-value-added