Retrieve a campaign - Heyoo Docs

{ "id": "<string>", "name": "<string>", "createdAt": "<string>", "description": "<string>", "destinationUrl": "<string>", "clicks": 123, "shares": 123, "startDate": "<string>", "endDate": "<string>", "targetShares": 123, "hasShared": true }

Authorizations

Authorization

string

header

required

Default authentication mechanism

Path Parameters

string

required

The ID of the campaign to retrieve.

Response

The campaign.

string

required

The unique ID of the campaign.

name

string

required

The name of the campaign.

status

enum<string>

required

The status of the campaign.

Available options:

draft,

published,

archived

createdAt

string

required

The creation date of the campaign.

description

string

required

The description of the campaign.

destinationUrl

string | null

required

The destination URL of the campaign.

clicks

number

required

The number of clicks the campaign has received.

number

required

The number of shares the campaign has received.

startDate

string

required

The start date of the campaign.

endDate

string

required

The end date of the campaign.

targetShares

number | null

required

The target shares for the campaign.

hasShared

boolean

Whether the authenticated user has shared this campaign.