Skip to main content
Leads are form submissions from viewers who filled in the CTA on one of your demo videos. Each lead captures the submitted field values along with which video it came from and when it was submitted.
Leads are only generated when cta_type is form. External link CTAs do not produce leads. To configure your CTA, see the CTA setup guide.

​
Lead fields

​
id
number
Unique identifier for the lead.
​
video_id
number
The ID of the video the lead was submitted from.
​
response_data
object
An object containing the submitted form values, keyed by field name (for example, name, email, company). The exact keys depend on the fields you configured for your CTA form.
​
submitted_at
string
ISO 8601 timestamp of when the form was submitted.
​
internal_name
string
The internal name of the video the lead came from.

​
Retrieving leads

Leads are always returned in reverse chronological order (most recent first).
Fetch all leads submitted on a specific video. Requires authentication.
GET /videos/:video_id/leads

​
Response format

All leads endpoints return the same structure: 
{
  "data": {
    "leads": [
      {
        "id": 42,
        "video_id": 7,
        "response_data": {
          "name": "Alice Smith",
          "email": "alice@example.com",
          "company": "Acme Corp"
        },
        "submitted_at": "2024-01-15T10:30:00.000Z",
        "internal_name": "Product Tour - Q1 2024"
      }
    ]
  }
}
The keys inside response_data match the field names you defined when setting up your CTA form. To add or change form fields, visit the CTA setup guide.