Skip to main content
GET
Get Campaign By Id

Autorisierungen

Authorization
string
header
erforderlich

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Pfadparameter

campaign_id
string<uuid>
erforderlich

The ID of the campaign.

Antwort

Successful Response

The campaign model.

campaignId
string<uuid>
erforderlich

The ID of the campaign.

marketplaceId
string<uuid>
erforderlich

The ID of the marketplace.

name
string
erforderlich

The name of the campaign.

Minimum string length: 1
Beispiel:

"Bola-Bola Ad campaign"

startDate
string<date-time>
erforderlich

The starting date of the campaign.

endDate
string<date-time>
erforderlich

The end date of the campaign.

isActive
boolean
erforderlich

Whether this campaign is active.

isSmart
boolean
erforderlich

Whether this campaign is "smart".

campaignType
enum<string>
erforderlich

The bidding method for the campaign.

Verfügbare Optionen:
manual,
autobidding,
exclusive
status
enum<string>
erforderlich

Represents the review status of a banner campaign.

Verfügbare Optionen:
approved,
pending,
rejected
createdAt
string<date-time>
erforderlich

When was this campaign created.

chargeType
erforderlich

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.

Verfügbare Optionen:
CPM,
CPC,
CPA
externalVendorId
string
erforderlich
veraltet

Deprecated since 2022-11-30. The ID of the vendor. Use vendor_id instead.

Minimum string length: 1
adFormat
enum<string>
erforderlich

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

Verfügbare Optionen:
listing,
banner,
sponsored_brand,
exclusive_listing,
exclusive_banner,
travel_listing,
flight_listing
Beispiel:

"listing"

isAutoTrigger
boolean
erforderlich

Whether the campaign is auto-triggered.

vendorId
string
erforderlich

The ID of the vendor.

Minimum string length: 1
walletId
string<uuid>
erforderlich

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

bidCount
integer
erforderlich
veraltet

Deprecated since 2025-12-19. The amount of active bids associated with this campaign. This field will be set to 0 once the notice period is over.

budget
Budget · object | null

The budget assigned to the campaign.

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
veraltet

Deprecated since 2023-08-31. This field is always null. For behavioral data use reporting service.

campaignBehaviorDataByDay
string | null
veraltet

Deprecated since 2023-08-31. 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.

Verfügbare Optionen:
impressions,
clicks,
conversions,
revenue
mediaType
enum<string> | null

Optional media type for banner campaigns. Set to video to allow the campaign to receive video events. Omit for standard image banners.

Verfügbare Optionen:
video
fallbackWalletId
string<uuid> | null

The optional fallback wallet to be used with this campaign.

multiplierConfig
PublicCampaignMultiplierConfig · object | null

The multiplier configuration for the campaign.

targetingFilters
PublicCampaignTargetingFilters · object | null

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

exclusionFilters
PublicCampaignExclusionFilters · object | null

The segments that the campaign will not target.