Video Leads

Fetch all leads captured through the CTA form on a specific video. Leads are returned in reverse chronological order (most recent first).

Endpoint

GET /v1/videos/:id/leads

Authentication

Pass your API key as a Bearer token in the Authorization header.

string

required

Your API key. Format: Bearer <api_key>.

Path parameters

number

required

The ID of the video to retrieve leads for.

Response

object

required

Hide properties

object[]

required

Array of lead objects ordered by most recent submission first. Empty array when no leads exist.

Show lead properties

number

required

Unique lead identifier.

number

required

ID of the video this lead was captured from.

object

required

Key-value map of the form fields submitted by the viewer. Field keys match the CTA form configuration on the domain.

string

required

ISO 8601 timestamp when the form was submitted.

string

required

Name of the video at the time of submission.

This endpoint only returns leads from CTA form submissions. Clicks on external link CTAs are tracked separately in the link_clicks field returned by Video Stats.

Error responses

Status	Description
`400`	The provided `id` is not a valid number.
`404`	No video found with the given ID in your account.

Examples

curl --request GET \
  --url https://api.demomatic.tech/v1/videos/7/leads \
  --header 'Authorization: Bearer YOUR_API_KEY'

const videoId = 7;

const response = await fetch(`https://api.demomatic.tech/v1/videos/${videoId}/leads`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
  },
});

const { data } = await response.json();
console.log(data.leads);

Response

200

{
  "data": {
    "leads": [
      {
        "id": 42,
        "video_id": 7,
        "response_data": {
          "name": "Alice Smith",
          "email": "alice@example.com"
        },
        "submitted_at": "2024-01-15T10:30:00.000Z",
        "internal_name": "Product Tour Q1 2024"
      }
    ]
  }
}

Overview

Videos

Domains

Endpoint

Authentication

Path parameters

Response

Error responses

Examples

Response

​Endpoint

​Authentication

​Path parameters

​Response

​Error responses

​Examples

​Response

Endpoint

Authentication

Path parameters

Response

Error responses

Examples

Response