experience_namestringrequired
Case insensitive. Possible values are ‘pla’, ‘toa’ and ‘carousel’
Allowed values:PLATOACAROUSEL
Submit Reporting
Submit a report for Product Listing Ads. Read more about Reports in our Media Platform Learning Center.
post
https://api.8451.com/kap/v2/report/{experience_name}
Path Parameters
Body
application/json
Body
application/json
ReportRequest
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
Response
application/json
Response
application/json
Successful Response
ReportResultResponse
headersarray[object]required
The headers of the report
Show Child Parameters
dataarrayrequired
The data of the report
totalCountintegerrequired
The total count of the report
post/report/{experience_name}
Authentication
Path Parameters
Body
{
"filters": [
{
"field": "brand",
"operator": "EQUALS",
"values": [
"BRAND NAME GOES HERE"
]
}
],
"startDate": "string",
"endDate": "string",
"pagination": {
"offset": 0,
"size": 0
},
"advertiserIds": [
0
],
"metrics": [
"unique_user_conversions"
],
"dimensions": [
"placement"
],
"sort": [
{
"field": {},
"order": "ASC"
}
]
}
application/json
Jwt Endpoint
This endpoint will return your JWT.
get
https://api.8451.com/kap/v2/jwt
Response
200 application/json
Response
200 application/json
Successful Response
get/jwt
Authentication
200 application/json
Jwt Claim Reading Endpoint
This endpoint will show what claims your JWT has.
get
https://api.8451.com/kap/v2/jwt/claims
Response
200 application/json
Response
200 application/json
Successful Response
get/jwt/claims
Authentication
200 application/json
Account
objectidinteger
Account ID number.
Default:
namestring
Name of the Account.
Default:
activeboolean
Is the Account active, True/False.
Default:true
Example
AccountResponse
objectdataarray[object]required
List of Accounts.
Show Child Parameters
metaobjectrequired
Show Child Parameters
Example