Skip to main content
GET
/
public
/
v1
/
campaign-service
/
campaigns
/
{campaign-id}
Get Campaign By Id
curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id} \
  --header 'Authorization: Bearer <token>'
{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Bola-Bola Ad campaign",
  "budget": {
    "amount": 1000,
    "amountRemaining": 123,
    "amountCarryover": 123,
    "amountUsed": 123,
    "type": "daily"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isSmart": true,
  "campaignType": "manual",
  "status": "approved",
  "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignBehaviorData": "<string>",
  "campaignBehaviorDataByDay": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "chargeType": "CPM",
  "exclusivityPrice": 123,
  "targetRoas": 123,
  "externalCampaignId": "<string>",
  "externalVendorId": "<string>",
  "adFormat": "listing",
  "isAutoTrigger": true,
  "autobiddingObjective": "impressions",
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": [
      {
        "url": "<string>",
        "contentType": "image/png",
        "dimensions": {
          "width": 1920,
          "height": 1080
        },
        "size": 123,
        "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
        "content": {},
        "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "slotId": "<string>",
    "deviceType": "desktop",
    "adFormat": "<string>"
  },
  "bidCount": 123
}

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

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 length: 1
Examples:

"Bola-Bola Ad campaign"

​
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. Campaign charge type.

CPM: cost per mille impressions CPC: cost per click CPA: cost per action. CPA reflects the total cost to achieve a conversion.

Available options:
CPM,
CPC,
CPA
​
externalVendorId
string
required
deprecated

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

Minimum 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 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
object | null

The budget assigned to the campaign. A campaign budget.

​
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
object | null

The multiplier configuration for the campaign.

​
targetingFilters
object | null

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

​
exclusionFilters
object | null

The segments that the campaign will not target. The segments of users that the campaign will not target.

​
promotionType
object | null
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