campaign

Search Campaigns

Changed on

Search all Campaigns this user has access to

get/campaign

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/campaign
  • Auth
    none declared

Query parameters

campaignIdinteger

Filter by Campaign Id

namestring

Filter by Name

tagsstring

Filter by Tags

exactTagsinteger

A flag indicating whether to treat the tags filter as an exact match

logicalOperatorstring

When filtering by multiple Tags, which logical operator should be used? AND|OR

hasLayoutsinteger

Filter by has layouts

isLayoutSpecificinteger

Filter by whether this Campaign is specific to a Layout or User added

retiredinteger

Filter by retired

totalDurationinteger

Should we total the duration?

embedstring

Embed related data such as layouts, permissions, tags and events

folderIdinteger

Filter by Folder ID

sortBy'campaignId' | 'campaign' | 'type' | 'startDt' | 'endDt' | 'numberLayouts' | 'totalDuration' | 'cyclePlaybackEnabled' | 'playCount' | 'targetType' | 'target' | 'plays' | 'spend' | 'impressions' | 'ref1' | 'ref2' | 'ref3' | 'ref4' | 'ref5' | 'createdAt' | 'modifiedAt' | 'modifiedByName'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

campaignIdinteger

The Campaign Id

ownerIdinteger

The userId of the User that owns this Campaign

typestring

The type of campaign, either list, ad, playlist or media

campaignstring

The name of the Campaign

isLayoutSpecificinteger

A 0|1 flag to indicate whether this is a Layout specific Campaign or not.

numberLayoutsinteger

The number of Layouts associated with this Campaign

totalDurationinteger

The total duration of the campaign (sum of layout's durations)

folderIdinteger

The id of the Folder this Campaign belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this Campaign

cyclePlaybackEnabledinteger

Flag indicating whether this Campaign has cycle based playback enabled

playCountinteger

In cycle based playback, how many plays should each Layout have before moving on?

listPlayOrderstring

In list campaign types, how should the layouts play out?

targetTypestring

For an ad campaign, what's the target type, plays|budget|imp

targetinteger

For an ad campaign, what's the target (expressed in targetType)

startDtinteger

For an ad campaign, what's the start date

endDtinteger

For an ad campaign, what's the end date

playsinteger

The number of plays achived by this campaign

spendnumber double

The amount of spend in cents/pence/etc

impressionsnumber double

The number of impressions achived by this campaign

lastPopIdinteger

The latest proof of play ID aggregated into the stats

ref1string

Reference field 1

ref2string

Reference field 1

ref3string

Reference field 1

ref4string

Reference field 1

ref5string

Reference field 1

Changes