POST
/
track
/
lead
require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::TrackLeadRequestBody.new(
  click_id: "<id>",
  event_name: "Sign up",
)
    
res = s.track.lead(req)

if ! res.object.nil?
  # handle response
end
{
  "click": {
    "id": "<string>"
  },
  "customer": {
    "name": "<string>",
    "email": "<string>",
    "avatar": "<string>",
    "externalId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Body

application/json
​
clickId
string
required

The ID of the click in Dub. You can read this value from dub_id cookie.

Minimum length: 1
​
eventName
string
required

The name of the lead event to track.

Required string length: 1 - 255
​
eventQuantity
number | null

The numerical value associated with this lead event (e.g., number of provisioned seats in a free trial). If defined as N, the lead event will be tracked N times.

​
externalId
string
default:

This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.

Maximum length: 100
​
customerId
string | null
deprecated

This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.

Maximum length: 100
​
customerName
string | null

Name of the customer in the client's app.

Maximum length: 100
​
customerEmail
string | null

Email of the customer in the client's app.

Maximum length: 100
​
customerAvatar
string | null

Avatar of the customer in the client's app.

​
metadata
object | null

Additional metadata to be stored with the lead event

Response

200
application/json
A lead was tracked.
​
click
object
required
​
customer
object
required

Was this page helpful?

Suggest editsRaise issue
Retrieve a list of eventsTrack a sale