Skip to main content
POST

Authorizations

Authorization
string
header
required

Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.

Headers

Content-Type
string
default:application/json
required

Request body type

Path Parameters

id
string
required

Encrypted campaign id

Body

application/json
page
integer
required

Page number (1-indexed).

Minimum: 1

Required range: x >= 1
limit
integer
required

Maximum rows per page.

Minimum: 1 Maximum: 100

Required range: 1 <= x <= 100
date_from
string

Optional. Only return clicks on or after this date. Format YYYY-MM-DD, interpreted in your account timezone.

date_to
string

Optional. Only return clicks on or before this date. Format YYYY-MM-DD, interpreted in your account timezone. Must be on or after date_from.

Response

OK

campaign
object
data
object[]
total
integer

Total number of contacts who clicked the campaign, ignoring pagination.