Sign in
ads
report

List all reports

get/ads/{connection_id}/report

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

org_idstring

The org ID to filter by (reference to AdsOrganization)

campaign_idstring

The campaign ID to filter by

group_idstring

The group ID to filter by (reference to AdsGroup)

ad_idstring

The ad ID to filter by

typestring

One or more (comma-separated) of: CLICKS, IMPRESSIONS, CONVERSIONS, COST, CTR, CPC, CONVERSION_VALUE, CPA, ROAS, CPM, ECPM, ENGAGEMENT, VIDEO_COMPLETIONS, VIDEO_VIEWS, LEADS, ENGAGEMENTS, SAVES, LIKES, SHARES, COMMENTS, FOLLOWS, POST_CLICK_CONVERSIONS, VIEW_THROUGH_CONVERSIONS, ALL_CONVERSIONS, ALL_CONVERSION_VALUE, INTERACTIONS, REVENUE, MEDIA_COST, TOTAL_MEDIA_COST, VIDEO_PLAYS, VIDEO_QUARTILE_25, VIDEO_QUARTILE_50, VIDEO_QUARTILE_75, VIDEO_QUARTILE_100, VIDEO_AVG_TIME_WATCHED, VIDEO_THRUPLAY, VIEWABLE_IMPRESSIONS, MEASURABLE_IMPRESSIONS, VIEWABILITY_RATE, BILLABLE_IMPRESSIONS, DATA_FEES, PLATFORM_FEES, PROFIT, LANDING_PAGE_CLICKS, LEAD_FORM_OPENS, AD_UNIT_CLICKS, CARD_CLICKS, CARD_IMPRESSIONS, COMMENT_LIKES, COMPANY_PAGE_CLICKS, ACTION_CLICKS, TEXT_URL_CLICKS, OTHER_ENGAGEMENTS, OPENS, TOTAL_ENGAGEMENTS, UNIQUE_IMPRESSIONS, UNIQUE_CLICKS, VIRAL_IMPRESSIONS, VIRAL_CLICKS, VIRAL_LIKES, VIRAL_COMMENTS, VIRAL_SHARES, VIRAL_FOLLOWS, VIRAL_VIDEO_PLAYS, VIRAL_VIDEO_VIEWS, VIRAL_VIDEO_COMPLETIONS, VIRAL_VIDEO_QUARTILE_25, VIRAL_VIDEO_QUARTILE_50, VIRAL_VIDEO_QUARTILE_75, VIRAL_LEADS, VIRAL_LEAD_FORM_OPENS, VIRAL_LANDING_PAGE_CLICKS, VIRAL_CONVERSIONS, VIRAL_POST_CLICK_CONVERSIONS, VIRAL_VIEW_THROUGH_CONVERSIONS, VIRAL_ENGAGEMENTS, GMAIL_SECONDARY_CLICKS, AVERAGE_CPV, VIDEO_VIEWS_FROM_SEARCH, CROSS_DEVICE_CONVERSIONS, ABSOLUTE_TOP_IMPRESSION_SHARE, TOP_IMPRESSION_SHARE, ABSOLUTE_TOP_IMPRESSION_RATE_PERCENT, TOP_IMPRESSION_RATE_PERCENT, VIDEO_FULLSCREENS, VIDEO_PAUSES, VIDEO_MUTES, VIDEO_SKIPS, COMPANION_CLICKS, COMPANION_VIEWS, ACTIVE_VIEW_AVG_TIME, ELIGIBLE_IMPRESSIONS, EARNED_VIEWS, UNIQUE_VIEWERS, COST_USD, VIRAL_CARD_CLICKS, VIRAL_CARD_IMPRESSIONS, VIRAL_COMPANY_PAGE_CLICKS, VIRAL_VIDEO_FULLSCREENS, VIRAL_OTHER_ENGAGEMENTS, LEAD_GEN_CONTACT_SHARES, LEAD_GEN_INTERESTED_CLICKS, CM360_POST_CLICK_REVENUE, CM360_POST_VIEW_REVENUE, SCROLLS, MEDIA_FEE_1, MEDIA_FEE_2, MEDIA_FEE_3, MEDIA_FEE_4, MEDIA_FEE_5, ACTIVE_VIEW_DIST_UNMEASURABLE, ACTIVE_VIEW_DIST_UNVIEWABLE, ACTIVE_VIEW_DIST_VIEWABLE, ACTIVE_VIEW_AUDIBLE_VISIBLE_COMPLETE, ACTIVE_VIEW_VISIBLE_10S, NOT_MEASURABLE_IMPRESSIONS, NOT_VIEWABLE_IMPRESSIONS, 1D_VIEW, 1D_CLICK, 7D_VIEW, 7D_CLICK, 14D_CLICK, 28D_VIEW, 28D_CLICK, 30D_CLICK, VISITS, AUDIO_MUTES

dimensionstring

One or more (comma-separated) of: DATE, PLATFORM, PLATFORM_POSITION, DEVICE

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
currencystring
start_atstring date-time
end_atstring date-time
organization_idstring
rawobject

Changes

Changed in 6 of the 34 revisions of this API.1618

  • fbf77d34910f3See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 1fbb53b883651See the full diff
    • ○

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

      response-optional-property-added

  • 6c78736a6d421See the full diff
    • ●

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

      response-property-enum-value-added

  • 1f72720916e45See 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

  • 963bcc74f9e398See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new optional query request parameter dimension

      new-optional-request-parameter

    • ○

      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

  • 8f243766856734See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-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