Search
K
Kroger Ad Platform API

PublishStatus

string

Allowed values:EMPTYPENDINGFAILEDPUBLISHED

ReportResultHeader

object
namestringrequired

The name of the header

typestringrequired

The type of the header

titlestringrequired

The title of the header

Example

ReportResultResponse

object
headersarray[object]required

The headers of the report

Show Child Parameters
dataarrayrequired

The data of the report

totalCountintegerrequired

The total count of the report

Example

Filter

object
fieldAny Of
required

The field to filter 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

operatorstringrequired

Allowed values:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALLIKE_INNOT_INIS_NULLNOT_NULLNOT_LIKEBETWEEN

valuesarray[string]required

The values to filter by

Example

Metrics

string

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