Get Campaign By Id

Endpoint to retrieve specific campaign by Campaign ID.

It is expected to use at Campaign Page.

GET /public/v1/campaign-service/campaigns/{campaign-id}

Try it

Get Campaign By Id

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id} \
  --header 'Authorization: Bearer <token>'

200

{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isSmart": true,
  "campaignType": "manual",
  "status": "approved",
  "createdAt": "2023-11-07T05:31:56Z",
  "chargeType": "CPM",
  "externalVendorId": "<string>",
  "adFormat": "listing",
  "isAutoTrigger": true,
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bidCount": 123,
  "budget": {
    "amount": 123,
    "amountRemaining": 123,
    "amountCarryover": 123,
    "amountUsed": 123,
    "type": "daily"
  },
  "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignBehaviorData": "<string>",
  "campaignBehaviorDataByDay": "<string>",
  "exclusivityPrice": 123,
  "targetRoas": 123,
  "externalCampaignId": "<string>",
  "autobiddingObjective": "impressions",
  "multiplierConfig": {
    "isActive": true,
    "multipliers": [
      {
        "type": "<string>",
        "segmentId": 123,
        "multiplier": 2
      }
    ]
  },
  "targetingFilters": {
    "isActive": true,
    "targetingFilters": [
      {
        "type": "<string>",
        "segmentId": 123
      }
    ]
  },
  "exclusionFilters": {
    "isActive": true,
    "exclusionFilters": [
      {
        "type": "<string>",
        "segmentId": 123
      }
    ]
  },
  "promotionType": {
    "bannerAssets": [
      {
        "dimensions": {
          "width": 123,
          "height": 123
        },
        "url": "<string>",
        "contentType": "image/png",
        "size": 123,
        "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
        "content": {},
        "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "slotId": "<string>",
    "adFormat": "<string>",
    "deviceType": "desktop"
  }
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Path Parameters

campaign-id · string<uuid> · required

The ID of the campaign.

Response

200

application/json

Successful Response

The campaign model.

campaignId · string<uuid> · required

The ID of the campaign.

marketplaceId · string<uuid> · required

The ID of the marketplace.

name · string · required

The name of the campaign.

Minimum string length: 1

startDate · string<date-time> · required

The starting date of the campaign.

endDate · string<date-time> · required

The end date of the campaign.

isActive · boolean · required

Whether this campaign is active.

isSmart · boolean · required

Whether this campaign is "smart".

campaignType · enum<string> · required

The bidding method for the campaign.

Available options: manual, autobidding, exclusive

status · enum<string> · required

Represents the review status of a banner campaign.

Available options: approved, pending, rejected

createdAt · string<date-time> · required

When was this campaign created.

chargeType · required

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

Available options: CPM, CPC, CPA

externalVendorId · string · required · deprecated

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

Minimum string length: 1

adFormat · enum<string> · required

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

Available options: listing, banner, sponsored_brand, exclusive_listing, exclusive_banner, travel_listing, flight_listing

isAutoTrigger · boolean · required

Whether the campaign is auto-triggered.

vendorId · string · required

The ID of the vendor.

Minimum string length: 1

walletId · string<uuid> · required

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

bidCount · integer · required

The amount of active bids associated with this campaign.

budget · Budget · object

The budget assigned to the campaign.

Show child attributes

budget. amount · integer<int64> · required

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

budget. amountRemaining · integer<int64> · required

The remaining amount of the budget.

budget. amountCarryover · integer<int64> · required

The amount carried over from the last period.

budget. amountUsed · integer<int64> · required

The used amount of the budget.

budget. type · enum<string> · required

The periodicity of the budget.

Available options: daily, weekly, monthly, total

statusUpdatedBy · string<uuid> | null

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.

campaignBehaviorData · string | null · deprecated

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

campaignBehaviorDataByDay · string | null · deprecated

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

exclusivityPrice · integer | null

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

targetRoas · number | null

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

externalCampaignId · string | null

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

autobiddingObjective · enum<string> | null

The autobidding objective for the campaign.

Available options: impressions, clicks, conversions, revenue

multiplierConfig · CampaignMultiplierConfig · object

The multiplier configuration for the campaign.

Show child attributes

multiplierConfig. isActive · boolean · required

Whether the multiplier is active.

multiplierConfig. multipliers · UserSegmentMultiplier · object[] · required

List of multipliers.

Maximum array length: 3

Show child attributes

multiplierConfig.multipliers. type · string · required

Multiplier type.

Allowed value: "user_segment"

multiplierConfig.multipliers. segmentId · integer · required

Internal user segment ID.

multiplierConfig.multipliers. multiplier · number · required

Multiplier value.

Required range: x >= 1

targetingFilters · CampaignTargetingFilters · object

The segments that the campaign will participate for (and will not for other segments not here).

Show child attributes

targetingFilters. isActive · boolean · required

Whether the filter is active.

targetingFilters. targetingFilters · TargetingFilter · object[] · required

List of filters.

Maximum array length: 3

Show child attributes

targetingFilters.targetingFilters. type · string · required

Segment type.

Allowed value: "user_segment"

targetingFilters.targetingFilters. segmentId · integer · required

Internal user segment ID.

exclusionFilters · CampaignExclusionFilters · object

The segments that the campaign will not target.

Show child attributes

exclusionFilters. isActive · boolean · required

Whether the filter is active.

exclusionFilters. exclusionFilters · ExclusionFilter · object[] · required

List of exclusion filters.

Maximum array length: 3

Show child attributes

exclusionFilters.exclusionFilters. type · string · required

Segment type.

Allowed value: "user_segment"

exclusionFilters.exclusionFilters. segmentId · integer · required

Internal user segment ID.

promotionType · BannerAd · 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.

BannerAd

ListingAd

ExclusiveBannerAd

ExclusiveListingAd

SponsoredBrandAd

Show child attributes

promotionType. bannerAssets · BannerAsset · object[] · required

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

Minimum array length: 1

Show child attributes

promotionType.bannerAssets. dimensions · Dimensions · object · required

The width and height of an asset.

Show child attributes

promotionType.bannerAssets.dimensions. width · integer · required

The width of the image.

promotionType.bannerAssets.dimensions. height · integer · required

The height of the image.

promotionType.bannerAssets. url · string<uri> | null

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

Required string length: 1 - 2083

promotionType.bannerAssets. contentType · string | null

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

Minimum string length: 1

Example:

"image/png"

promotionType.bannerAssets. size · integer | null

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

promotionType.bannerAssets. assetId · string | null

Asset id, if created using the asset API.

Maximum string length: 33

Example:

"asset_01j713j64yfsvtj4bs3ccpy5ca"

promotionType.bannerAssets. content · Content · object

Custom additional metadata about the banner. If provided, the asset_id and url fields will be ignored. Maximum size is 20KB when serialized.

Show child attributes

promotionType.bannerAssets.content. {key}

promotionType.bannerAssets. jsonTemplateId · string<uuid> | null

The id of the json template that was used to create the json content.

promotionType. slotId · string · required

The external slot id provided by the marketplace.

Minimum string length: 1

promotionType. adFormat · string · required

Allowed value: "banner"

promotionType. deviceType · enum<string> · default: desktop

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

Available options: mobile, desktop