v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB

Basic

Read 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.

get/marketing/campaigns/2026-03/{campaignGuid}

Path parameters

campaignGuidstring required

The UUID of the campaign, required Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8

Query parameters

endDatestring

The end date for fetching asset metrics, in YYYY-MM-DD format. Optional. Example: 2000-01-27

propertiesstring[]

A comma-separated list of properties to include in the response.
Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes

startDatestring

The start date for fetching asset metrics, in YYYY-MM-DD format.
Optional. Example: 2000-01-20

Response

successful operation

assetsobject required

Contains the assets associated with the campaign, each represented as a collection of campaign assets.

createdAtstring date-time required

The date and time when the campaign was created, formatted as a date-time string.

idstring required

The unique identifier for the campaign.

propertiesobject required

A map of key-value pairs representing the properties of the campaign.

updatedAtstring date-time required

The date and time when the campaign was last updated, formatted as a date-time string.