Retrieve a campaign
Get a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets’ metrics. Metrics are available only if startDate and endDate are provided.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The UUID of the campaign, required Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
Query Parameters
The end date for fetching asset metrics, in YYYY-MM-DD format. Optional. Example: 2000-01-27
A comma-separated list of properties to include in the response.
Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes
The start date for fetching asset metrics, in YYYY-MM-DD format.
Optional. Example: 2000-01-20
Response
successful operation
Contains the assets associated with the campaign, each represented as a collection of campaign assets.
An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
The date and time when the campaign was created, formatted as a date-time string.
The unique identifier for the campaign.
A map of key-value pairs representing the properties of the campaign.
The date and time when the campaign was last updated, formatted as a date-time string.