campaigns

Get Campaign

Get a single campaign by ID.

get/api/v1/campaigns/{campaign_id}

Request

  • Base URL: https://app.kaminari.ad
  • URL: https://app.kaminari.ad/api/v1/campaigns/{campaign_id}
  • Auth: HTTP bearer

Path parameters

campaign_idstring uuid required

Response

Successful Response

idstring uuid required
namestring required
campaign_typestring
urlstring required
ad_tagstring nullable
vast_tagstring nullable
referrerstring nullable
ignore_first_n_domainsinteger
max_discovered_adsinteger nullable
ad_formatsDiscoveryAdFormat[] nullable
country_codesstring[] required
group_idstring uuid required
proxy_typestring
proxy_regionstring
proxy_citystring
proxy_ispstring
repeat_countinteger
repeat_mode'isolated' | 'shared'

How the repeats of one url x country x device relate to each other.

Value-compatible with scanning's RepeatModeType — campaigns owns its own copy because the write side must not import another domain's package (check-imports), and only the value crosses the boundary.

retry_max_attemptsinteger
schedule_typestring nullable
schedule_weeklyobject nullable
schedule_interval_secondsinteger nullable
schedule_timezonestring nullable
labelsobject
policy_set_idstring uuid nullable
schedule_enabledboolean required
is_archivedboolean required
created_atstring date-time required
last_run_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.