Campaigns Report

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response

Field
Type
Description
idintThe campaign ID
media_plan_idintThe media strategy ID
namestringThe campaign name
start_datestringThe campaign start date
end_datestringThe end_date of the campaign
statusstringThe status of the campaign
always_onboolWhether the campaign is always on, or if there is a configured end date.
is_auto_bidboolWhether the bids are utilizing Koddi's bid automation functionality
publisher_ididThe publisher ID for the campaign
enable_frequency_cappingboolWhether frequency capping is enabled for your campaign. Please work with your Koddi team to enable this functionality
frequency_cappingstringWhat value the campaign is capped at, relative to frequency. Pleaes work with your Koddi team to enable this functionality
pacingstringThe pacing type selected for the campaign
budgetobjectThe budget details of the campaign
typestringThe type of budget for the campaign
amountfloatThe budget amount for the campaign
primary_goalobjectThe primary goal set for the campaign
typestringThe primary goal type. These will be configured for your client
valuestringThe goal value, relative to the goal type
secondary_goalobjectThe secondary goal set for the campaign
typestringThe secondary goal type. These will be configured for your client
valuestringThe goal value, relative to the goal type

Try it!

Path Params
int32
required

The member group ID (provided by Koddi)

int32
required

The advertiser ID

Body Params
pagination
object

Optional (will be 20 elements by default). The pagination parameters.

sort
array of objects

The object containing the sorting details of the report. The report will default to last modified ascending if the sort object is not provided.

sort
filters
array of objects

The object containing the filtering details for the report

filters
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json