Get Campaigns

Endpoint to retrieve campaigns. Campaigns can be filtered by Vendor ID and status.

It is expected to use for getting all campaigns of a marketplace & all campaigns of a vendor in dashboards. Filtering by status is expected to use at review page getting campaigns approved, pending tabs.

Query Parameters

vendor_id

string

The ID of the vendor. Omit to get campaigns for all vendors.

Minimum length: 1

status

enum<string>

Filter by the approval status of banner campaigns.

Available options:

approved,

pending,

rejected

offset

integer

default:

0

The pagination offset.

Required range: x > 0

limit

integer

default:

100

The pagination limit.

Required range: 0 < x < 100

is_active

boolean

Filter by active/inactive campaigns.

sort_by_date

enum<string>

Optional sort by date of campaign creation.

Available options:

asc,

desc

Response

200 - application/json

The campaigns response.

campaigns

object[]

required

An array of campaigns.

Show child attributes

campaigns.adFormat

enum<string>

required

The ad format of the campaign. Can be listing or banner.

Available options:

listing,

banner

campaigns.bidCount

integer

required

The amount of active bids associated with this campaign.

campaigns.campaignId

string

required

The ID of the campaign.

campaigns.campaignType

enum<string>

required

The bidding method for the campaign.

Available options:

manual,

autobidding,

exclusive

campaigns.chargeType

enum<string>

required

How campaigns are going to be charged, by click, by per mille impressions, or by action.

Available options:

CPM,

CPC,

CPA

campaigns.createdAt

string

required

When was this campaign created.

campaigns.endDate

string

required

The end date of the campaign.

campaigns.externalVendorId

string

requireddeprecated

The ID of the vendor. Deprecated. Use vendor_id instead.

Minimum length: 1

campaigns.isActive

boolean

required

Whether this campaign is active.

campaigns.isSmart

boolean

required

Whether this campaign is "smart".

campaigns.marketplaceId

string

required

The ID of the marketplace.

campaigns.name

string

required

The name of the campaign.

Minimum length: 1

campaigns.startDate

string

required

The starting date of the campaign.

campaigns.status

enum<string>

required

Represents the review status of a banner campaign.

Available options:

approved,

pending,

rejected

campaigns.vendorId

string

required

The ID of the vendor.

Minimum length: 1

campaigns.walletId

string

required

The uuid of the wallet to be used with this campaign.

campaigns.budget

object

The budget assigned to the campaign.

Show child attributes

campaigns.budget.amount

integer

required

The amount of money in the budget in minor units of currency according to ISO 4217.

Required range: 0 < x < 20000000000

campaigns.budget.amountCarryover

integer

required

The amount carried over from the last period.

campaigns.budget.amountRemaining

integer

required

The remaining amount of the budget.

campaigns.budget.amountUsed

integer

required

The used amount of the budget.

campaigns.budget.type

enum<string>

required

The periodicity of the budget.

Available options:

daily,

weekly,

monthly,

total

campaigns.campaignBehaviorData

string

deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

campaigns.campaignBehaviorDataByDay

string

deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

campaigns.exclusivityPrice

integer

Daily price for an exclusive campaign, can only be set if a campaign is exclusive

campaigns.externalCampaignId

string

The external ID of the campaign in the marketplace.

campaigns.isVendorCampaign

boolean

default:

false

Whether this is a promoted shop campaign.

campaigns.promotionType

object

deprecated

Deprecated. Use adFormat field instead and format properties inside bids. The promotion type and attributes. Ad format must set to 'banner' for exclusive campaigns.

• Promotiontype
• Promotiontype

Show child attributes

campaigns.promotionType.adFormat

enum<string>

required

Available options:

banner

campaigns.promotionType.bannerAssets

object[]

required

The assets for the banner campaign, if adFormat is banner.

Show child attributes

campaigns.promotionType.bannerAssets.dimensions

object

required

The width and height of an asset.

Show child attributes

campaigns.promotionType.bannerAssets.dimensions.height

integer

required

The height of the image.

Required range: x > 0

campaigns.promotionType.bannerAssets.dimensions.width

integer

required

The width of the image.

Required range: x > 0

campaigns.promotionType.bannerAssets.assetId

string

Asset id, if created using the asset API.

Maximum length: 33

campaigns.promotionType.bannerAssets.contentType

string

The mime type of the asset. If asset_id is provided, this field will be ignored.

Minimum length: 1

campaigns.promotionType.bannerAssets.size

integer

The file size of the asset, in bytes. If asset_id is provided, this field will be ignored.

campaigns.promotionType.bannerAssets.url

string

The url where the asset is located. If asset_id is provided, this field will be ignored.

Required string length: 1 - 2083

campaigns.promotionType.slotId

string

required

The external slot id provided by the marketplace.

Minimum length: 1

campaigns.promotionType.deviceType

enum<string>

default:

desktop

The targeted device for this campaign, if adFormat is banner.

Available options:

mobile,

desktop

campaigns.statusUpdatedBy

string

The ID of the user who reviewed the campaign. If it's null and the status is not "pending" then it means this campaign has autoapproval status.

campaigns.targetRoas

number

The target return on ad spend (ROAS) for this campaign. This is only applicable for autobidding listing campaigns.

hasMore

boolean

required

Whether this is the last page of results or not.

next

object

The parameters that should be used to fetch the next page.

Show child attributes

next.limit

integer

required

How many items to return.

next.offset

integer

required

How many items to skip from the beginning of the list.