Search
K
Kroger Ad Platform API

SortField

object
fieldAny Of
required

The field to sort by

Metricsstring

Allowed values:unique_user_conversionsunique_user_impressionsviewed_conversion_rateviewed_unit_price_avgclick_through_rateclicked_conversion_rateclicked_order_value_avgclicked_unit_price_avgclicksviewed_order_value_avgcostcost_per_clickcost_per_transactioncost_per_thousandhalo_revenuehalo_exposed_revenuehalo_roashalo_exposed_roashalo_transactionshalo_exposed_transactionshalo_unitshalo_exposed_unitsimpressionsad_group_budgetad_group_budget_typead_group_end_datead_group_start_datead_group_statuscampaign_budgetcampaign_budget_typecampaign_end_datecampaign_start_datecampaign_statuspacingwin_ratehours_liveopportunitiesshare_of_voicetime_livevideo_startsvideo_pausesvideo_completesvideo_total_durationvideo_average_duration_viewedvideo_first_quartile_viewsvideo_first_quartile_view_ratevideo_second_quartile_viewsvideo_second_quartile_view_ratevideo_third_quartile_viewsvideo_third_quartile_view_ratevideo_complete_view_ratevideo_view_through_rate

orderstringrequired

Allowed values:ASCDESC

Example

SortOrderCommon

string

Allowed values:ASCDESC

ReportRequest

object
filtersarray[object]required

The filters to apply

Show Child Parameters
startDatestringrequired

The start date of the report

endDatestringrequired

The end date of the report

paginationobjectrequired
Show Child Parameters
advertiserIdsarray[integer]required

The advertiser ids to filter by

metricsarray[string]required

The metrics to aggregate

Allowed values:unique_user_conversionsunique_user_impressionsviewed_conversion_rateviewed_unit_price_avgclick_through_rateclicked_conversion_rateclicked_order_value_avgclicked_unit_price_avgclicksviewed_order_value_avgcostcost_per_clickcost_per_transactioncost_per_thousandhalo_revenuehalo_exposed_revenuehalo_roashalo_exposed_roashalo_transactionshalo_exposed_transactionshalo_unitshalo_exposed_unitsimpressionsad_group_budgetad_group_budget_typead_group_end_datead_group_start_datead_group_statuscampaign_budgetcampaign_budget_typecampaign_end_datecampaign_start_datecampaign_statuspacingwin_ratehours_liveopportunitiesshare_of_voicetime_livevideo_startsvideo_pausesvideo_completesvideo_total_durationvideo_average_duration_viewedvideo_first_quartile_viewsvideo_first_quartile_view_ratevideo_second_quartile_viewsvideo_second_quartile_view_ratevideo_third_quartile_viewsvideo_third_quartile_view_ratevideo_complete_view_ratevideo_view_through_rate

dimensionsarray[string]required

The dimensions to group by

Allowed values:placementdivision_bannerkeywordad_group_idad_group_nameadvertiser_idadvertiser_namecampaign_idcampaign_nameconversion_sourcedaily_dateentity_identity_namepurchased_entity_idpurchased_entity_namehouraccountsad_group_short_idadvertiser_typebillingsbrandbrand_namescampaign_short_idexperience_nameio_line_item_amountio_line_item_nameio_line_item_numberio_nameio_numberio_remaining_amountio_total_amountmonth_dateprimaryAccountNamepurchase_order_numberweek_datecommoditycommodity_iddepartmentdepartment_idsub_commoditysub_commodity_idcreative_keycreative_namesegment_idsentity_groupentity_group_id

sortarray[object]required

The sort order

Show Child Parameters
Example

SingleResponse[AdGroupV2]

object
dataAny Of

Data of the response.

AdGroupV2object
Show Child Parameters
metaobjectrequired
Show Child Parameters
Example

SingleResponse[AdGroup]

object
dataAny Of

Data of the response.

AdGroupobject
Show Child Parameters
metaobjectrequired
Show Child Parameters
Example