Skip to main content
POST
Campaign URL Builder

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioWebsiteUrl
string
required

Website URL

ioSource
string
required

Campaign Source

ioMedium
string
required

Campaign Medium

ioCampaign
string
required

Campaign Name

ioTerm
string

Campaign Term

ioContent
string

Campaign Content

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.