Record a presentation event

curl --request POST \
  --url https://app.demand-iq.com/api/presentations/{presentationId}/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "_token": "<string>",
  "pointerCoarse": true,
  "introShown": true,
  "openSource": "<string>",
  "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slideId": "<string>",
  "slideIndex": 123,
  "durationMs": 123,
  "skipped": true,
  "views": [
    {
      "slideId": "<string>",
      "slideIndex": 123,
      "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "durationMs": 123,
      "skipped": true,
      "narrationStarted": true,
      "narrationCompleted": true,
      "secondsPlayed": 1,
      "secondsAvailable": 1
    }
  ],
  "ctaType": "<string>",
  "ctaLabel": "<string>",
  "ctaUrl": "<string>",
  "repMode": true,
  "firstScreen": "intro",
  "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slidesViewed": 1,
  "slidesTotal": 1,
  "furthestSlideIndex": 1,
  "totalDwellMs": 1,
  "ctaConfigured": true,
  "slidesNarrationStarted": 1,
  "slidesNarrationCompleted": 1,
  "totalSecondsPlayed": 1,
  "totalSecondsAvailable": 1,
  "qaVoiceAudioStarted": 1,
  "qaVoiceAudioCompleted": 1,
  "qaChatAudioStarted": 1,
  "qaChatAudioCompleted": 1
}
'

import requests

url = "https://app.demand-iq.com/api/presentations/{presentationId}/events"

payload = {
    "_token": "<string>",
    "pointerCoarse": True,
    "introShown": True,
    "openSource": "<string>",
    "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slideId": "<string>",
    "slideIndex": 123,
    "durationMs": 123,
    "skipped": True,
    "views": [
        {
            "slideId": "<string>",
            "slideIndex": 123,
            "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "durationMs": 123,
            "skipped": True,
            "narrationStarted": True,
            "narrationCompleted": True,
            "secondsPlayed": 1,
            "secondsAvailable": 1
        }
    ],
    "ctaType": "<string>",
    "ctaLabel": "<string>",
    "ctaUrl": "<string>",
    "repMode": True,
    "firstScreen": "intro",
    "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slidesViewed": 1,
    "slidesTotal": 1,
    "furthestSlideIndex": 1,
    "totalDwellMs": 1,
    "ctaConfigured": True,
    "slidesNarrationStarted": 1,
    "slidesNarrationCompleted": 1,
    "totalSecondsPlayed": 1,
    "totalSecondsAvailable": 1,
    "qaVoiceAudioStarted": 1,
    "qaVoiceAudioCompleted": 1,
    "qaChatAudioStarted": 1,
    "qaChatAudioCompleted": 1
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    _token: '<string>',
    pointerCoarse: true,
    introShown: true,
    openSource: '<string>',
    viewId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    slideId: '<string>',
    slideIndex: 123,
    durationMs: 123,
    skipped: true,
    views: [
      {
        slideId: '<string>',
        slideIndex: 123,
        viewId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        durationMs: 123,
        skipped: true,
        narrationStarted: true,
        narrationCompleted: true,
        secondsPlayed: 1,
        secondsAvailable: 1
      }
    ],
    ctaType: '<string>',
    ctaLabel: '<string>',
    ctaUrl: '<string>',
    repMode: true,
    firstScreen: 'intro',
    conversationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    slidesViewed: 1,
    slidesTotal: 1,
    furthestSlideIndex: 1,
    totalDwellMs: 1,
    ctaConfigured: true,
    slidesNarrationStarted: 1,
    slidesNarrationCompleted: 1,
    totalSecondsPlayed: 1,
    totalSecondsAvailable: 1,
    qaVoiceAudioStarted: 1,
    qaVoiceAudioCompleted: 1,
    qaChatAudioStarted: 1,
    qaChatAudioCompleted: 1
  })
};

fetch('https://app.demand-iq.com/api/presentations/{presentationId}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.demand-iq.com/api/presentations/{presentationId}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '_token' => '<string>',
    'pointerCoarse' => true,
    'introShown' => true,
    'openSource' => '<string>',
    'viewId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'slideId' => '<string>',
    'slideIndex' => 123,
    'durationMs' => 123,
    'skipped' => true,
    'views' => [
        [
                'slideId' => '<string>',
                'slideIndex' => 123,
                'viewId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'durationMs' => 123,
                'skipped' => true,
                'narrationStarted' => true,
                'narrationCompleted' => true,
                'secondsPlayed' => 1,
                'secondsAvailable' => 1
        ]
    ],
    'ctaType' => '<string>',
    'ctaLabel' => '<string>',
    'ctaUrl' => '<string>',
    'repMode' => true,
    'firstScreen' => 'intro',
    'conversationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'slidesViewed' => 1,
    'slidesTotal' => 1,
    'furthestSlideIndex' => 1,
    'totalDwellMs' => 1,
    'ctaConfigured' => true,
    'slidesNarrationStarted' => 1,
    'slidesNarrationCompleted' => 1,
    'totalSecondsPlayed' => 1,
    'totalSecondsAvailable' => 1,
    'qaVoiceAudioStarted' => 1,
    'qaVoiceAudioCompleted' => 1,
    'qaChatAudioStarted' => 1,
    'qaChatAudioCompleted' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.demand-iq.com/api/presentations/{presentationId}/events"

	payload := strings.NewReader("{\n  \"_token\": \"<string>\",\n  \"pointerCoarse\": true,\n  \"introShown\": true,\n  \"openSource\": \"<string>\",\n  \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slideId\": \"<string>\",\n  \"slideIndex\": 123,\n  \"durationMs\": 123,\n  \"skipped\": true,\n  \"views\": [\n    {\n      \"slideId\": \"<string>\",\n      \"slideIndex\": 123,\n      \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"durationMs\": 123,\n      \"skipped\": true,\n      \"narrationStarted\": true,\n      \"narrationCompleted\": true,\n      \"secondsPlayed\": 1,\n      \"secondsAvailable\": 1\n    }\n  ],\n  \"ctaType\": \"<string>\",\n  \"ctaLabel\": \"<string>\",\n  \"ctaUrl\": \"<string>\",\n  \"repMode\": true,\n  \"firstScreen\": \"intro\",\n  \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slidesViewed\": 1,\n  \"slidesTotal\": 1,\n  \"furthestSlideIndex\": 1,\n  \"totalDwellMs\": 1,\n  \"ctaConfigured\": true,\n  \"slidesNarrationStarted\": 1,\n  \"slidesNarrationCompleted\": 1,\n  \"totalSecondsPlayed\": 1,\n  \"totalSecondsAvailable\": 1,\n  \"qaVoiceAudioStarted\": 1,\n  \"qaVoiceAudioCompleted\": 1,\n  \"qaChatAudioStarted\": 1,\n  \"qaChatAudioCompleted\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.demand-iq.com/api/presentations/{presentationId}/events")
  .header("Content-Type", "application/json")
  .body("{\n  \"_token\": \"<string>\",\n  \"pointerCoarse\": true,\n  \"introShown\": true,\n  \"openSource\": \"<string>\",\n  \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slideId\": \"<string>\",\n  \"slideIndex\": 123,\n  \"durationMs\": 123,\n  \"skipped\": true,\n  \"views\": [\n    {\n      \"slideId\": \"<string>\",\n      \"slideIndex\": 123,\n      \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"durationMs\": 123,\n      \"skipped\": true,\n      \"narrationStarted\": true,\n      \"narrationCompleted\": true,\n      \"secondsPlayed\": 1,\n      \"secondsAvailable\": 1\n    }\n  ],\n  \"ctaType\": \"<string>\",\n  \"ctaLabel\": \"<string>\",\n  \"ctaUrl\": \"<string>\",\n  \"repMode\": true,\n  \"firstScreen\": \"intro\",\n  \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slidesViewed\": 1,\n  \"slidesTotal\": 1,\n  \"furthestSlideIndex\": 1,\n  \"totalDwellMs\": 1,\n  \"ctaConfigured\": true,\n  \"slidesNarrationStarted\": 1,\n  \"slidesNarrationCompleted\": 1,\n  \"totalSecondsPlayed\": 1,\n  \"totalSecondsAvailable\": 1,\n  \"qaVoiceAudioStarted\": 1,\n  \"qaVoiceAudioCompleted\": 1,\n  \"qaChatAudioStarted\": 1,\n  \"qaChatAudioCompleted\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.demand-iq.com/api/presentations/{presentationId}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"_token\": \"<string>\",\n  \"pointerCoarse\": true,\n  \"introShown\": true,\n  \"openSource\": \"<string>\",\n  \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slideId\": \"<string>\",\n  \"slideIndex\": 123,\n  \"durationMs\": 123,\n  \"skipped\": true,\n  \"views\": [\n    {\n      \"slideId\": \"<string>\",\n      \"slideIndex\": 123,\n      \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"durationMs\": 123,\n      \"skipped\": true,\n      \"narrationStarted\": true,\n      \"narrationCompleted\": true,\n      \"secondsPlayed\": 1,\n      \"secondsAvailable\": 1\n    }\n  ],\n  \"ctaType\": \"<string>\",\n  \"ctaLabel\": \"<string>\",\n  \"ctaUrl\": \"<string>\",\n  \"repMode\": true,\n  \"firstScreen\": \"intro\",\n  \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slidesViewed\": 1,\n  \"slidesTotal\": 1,\n  \"furthestSlideIndex\": 1,\n  \"totalDwellMs\": 1,\n  \"ctaConfigured\": true,\n  \"slidesNarrationStarted\": 1,\n  \"slidesNarrationCompleted\": 1,\n  \"totalSecondsPlayed\": 1,\n  \"totalSecondsAvailable\": 1,\n  \"qaVoiceAudioStarted\": 1,\n  \"qaVoiceAudioCompleted\": 1,\n  \"qaChatAudioStarted\": 1,\n  \"qaChatAudioCompleted\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Presentations

Record a presentation event

Ingests interaction events from the presentation viewer (opens, presses of the intro Start button, the first time slides are shown, slide views, narration playback, CTA clicks, last-slide arrivals, and per-session summaries). Authenticated via an HMAC token in the request body. Every slide exit is recorded: slide_viewed accepts an optional skipped flag for views under the 2-second skip threshold, and slide_viewed_batch submits up to 25 slide views in one request. Narration playback outcomes are always batched via narration_played_batch (up to 25 outcomes per request); each outcome reports whether narration actually started, whether it completed, and seconds played vs. seconds available. last_slide_reached is sent once per page load when the viewer arrives on the last slide. AI Presentations records presentation.completed only when that slide is the presentation’s last slide and the presentation is ready. It records a completion for every visit, including reloads on the last slide. session_summary and narration_session_summary are cumulative, monotone, page-exit mirrors written to PostHog only. Each request costs 1 against the per-IP rate limit of 60 requests per minute, including narration_played_batch requests. Every view in a batch after the first costs 1 more. For slide_viewed_batch, that extra cost counts against the same per-IP limit. For narration_played_batch, it counts against a separate narration bucket. The limit returns 429 when exceeded. The action_detection and action_execution types, and untyped Q&A interaction bodies, are acknowledged with 200 for backward compatibility but are no longer stored.

POST

api

presentations

{presentationId}

events

Record a presentation event

curl --request POST \
  --url https://app.demand-iq.com/api/presentations/{presentationId}/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "_token": "<string>",
  "pointerCoarse": true,
  "introShown": true,
  "openSource": "<string>",
  "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slideId": "<string>",
  "slideIndex": 123,
  "durationMs": 123,
  "skipped": true,
  "views": [
    {
      "slideId": "<string>",
      "slideIndex": 123,
      "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "durationMs": 123,
      "skipped": true,
      "narrationStarted": true,
      "narrationCompleted": true,
      "secondsPlayed": 1,
      "secondsAvailable": 1
    }
  ],
  "ctaType": "<string>",
  "ctaLabel": "<string>",
  "ctaUrl": "<string>",
  "repMode": true,
  "firstScreen": "intro",
  "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slidesViewed": 1,
  "slidesTotal": 1,
  "furthestSlideIndex": 1,
  "totalDwellMs": 1,
  "ctaConfigured": true,
  "slidesNarrationStarted": 1,
  "slidesNarrationCompleted": 1,
  "totalSecondsPlayed": 1,
  "totalSecondsAvailable": 1,
  "qaVoiceAudioStarted": 1,
  "qaVoiceAudioCompleted": 1,
  "qaChatAudioStarted": 1,
  "qaChatAudioCompleted": 1
}
'

import requests

url = "https://app.demand-iq.com/api/presentations/{presentationId}/events"

payload = {
    "_token": "<string>",
    "pointerCoarse": True,
    "introShown": True,
    "openSource": "<string>",
    "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slideId": "<string>",
    "slideIndex": 123,
    "durationMs": 123,
    "skipped": True,
    "views": [
        {
            "slideId": "<string>",
            "slideIndex": 123,
            "viewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "durationMs": 123,
            "skipped": True,
            "narrationStarted": True,
            "narrationCompleted": True,
            "secondsPlayed": 1,
            "secondsAvailable": 1
        }
    ],
    "ctaType": "<string>",
    "ctaLabel": "<string>",
    "ctaUrl": "<string>",
    "repMode": True,
    "firstScreen": "intro",
    "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slidesViewed": 1,
    "slidesTotal": 1,
    "furthestSlideIndex": 1,
    "totalDwellMs": 1,
    "ctaConfigured": True,
    "slidesNarrationStarted": 1,
    "slidesNarrationCompleted": 1,
    "totalSecondsPlayed": 1,
    "totalSecondsAvailable": 1,
    "qaVoiceAudioStarted": 1,
    "qaVoiceAudioCompleted": 1,
    "qaChatAudioStarted": 1,
    "qaChatAudioCompleted": 1
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    _token: '<string>',
    pointerCoarse: true,
    introShown: true,
    openSource: '<string>',
    viewId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    slideId: '<string>',
    slideIndex: 123,
    durationMs: 123,
    skipped: true,
    views: [
      {
        slideId: '<string>',
        slideIndex: 123,
        viewId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        durationMs: 123,
        skipped: true,
        narrationStarted: true,
        narrationCompleted: true,
        secondsPlayed: 1,
        secondsAvailable: 1
      }
    ],
    ctaType: '<string>',
    ctaLabel: '<string>',
    ctaUrl: '<string>',
    repMode: true,
    firstScreen: 'intro',
    conversationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    slidesViewed: 1,
    slidesTotal: 1,
    furthestSlideIndex: 1,
    totalDwellMs: 1,
    ctaConfigured: true,
    slidesNarrationStarted: 1,
    slidesNarrationCompleted: 1,
    totalSecondsPlayed: 1,
    totalSecondsAvailable: 1,
    qaVoiceAudioStarted: 1,
    qaVoiceAudioCompleted: 1,
    qaChatAudioStarted: 1,
    qaChatAudioCompleted: 1
  })
};

fetch('https://app.demand-iq.com/api/presentations/{presentationId}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.demand-iq.com/api/presentations/{presentationId}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '_token' => '<string>',
    'pointerCoarse' => true,
    'introShown' => true,
    'openSource' => '<string>',
    'viewId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'slideId' => '<string>',
    'slideIndex' => 123,
    'durationMs' => 123,
    'skipped' => true,
    'views' => [
        [
                'slideId' => '<string>',
                'slideIndex' => 123,
                'viewId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'durationMs' => 123,
                'skipped' => true,
                'narrationStarted' => true,
                'narrationCompleted' => true,
                'secondsPlayed' => 1,
                'secondsAvailable' => 1
        ]
    ],
    'ctaType' => '<string>',
    'ctaLabel' => '<string>',
    'ctaUrl' => '<string>',
    'repMode' => true,
    'firstScreen' => 'intro',
    'conversationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'slidesViewed' => 1,
    'slidesTotal' => 1,
    'furthestSlideIndex' => 1,
    'totalDwellMs' => 1,
    'ctaConfigured' => true,
    'slidesNarrationStarted' => 1,
    'slidesNarrationCompleted' => 1,
    'totalSecondsPlayed' => 1,
    'totalSecondsAvailable' => 1,
    'qaVoiceAudioStarted' => 1,
    'qaVoiceAudioCompleted' => 1,
    'qaChatAudioStarted' => 1,
    'qaChatAudioCompleted' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.demand-iq.com/api/presentations/{presentationId}/events"

	payload := strings.NewReader("{\n  \"_token\": \"<string>\",\n  \"pointerCoarse\": true,\n  \"introShown\": true,\n  \"openSource\": \"<string>\",\n  \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slideId\": \"<string>\",\n  \"slideIndex\": 123,\n  \"durationMs\": 123,\n  \"skipped\": true,\n  \"views\": [\n    {\n      \"slideId\": \"<string>\",\n      \"slideIndex\": 123,\n      \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"durationMs\": 123,\n      \"skipped\": true,\n      \"narrationStarted\": true,\n      \"narrationCompleted\": true,\n      \"secondsPlayed\": 1,\n      \"secondsAvailable\": 1\n    }\n  ],\n  \"ctaType\": \"<string>\",\n  \"ctaLabel\": \"<string>\",\n  \"ctaUrl\": \"<string>\",\n  \"repMode\": true,\n  \"firstScreen\": \"intro\",\n  \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slidesViewed\": 1,\n  \"slidesTotal\": 1,\n  \"furthestSlideIndex\": 1,\n  \"totalDwellMs\": 1,\n  \"ctaConfigured\": true,\n  \"slidesNarrationStarted\": 1,\n  \"slidesNarrationCompleted\": 1,\n  \"totalSecondsPlayed\": 1,\n  \"totalSecondsAvailable\": 1,\n  \"qaVoiceAudioStarted\": 1,\n  \"qaVoiceAudioCompleted\": 1,\n  \"qaChatAudioStarted\": 1,\n  \"qaChatAudioCompleted\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.demand-iq.com/api/presentations/{presentationId}/events")
  .header("Content-Type", "application/json")
  .body("{\n  \"_token\": \"<string>\",\n  \"pointerCoarse\": true,\n  \"introShown\": true,\n  \"openSource\": \"<string>\",\n  \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slideId\": \"<string>\",\n  \"slideIndex\": 123,\n  \"durationMs\": 123,\n  \"skipped\": true,\n  \"views\": [\n    {\n      \"slideId\": \"<string>\",\n      \"slideIndex\": 123,\n      \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"durationMs\": 123,\n      \"skipped\": true,\n      \"narrationStarted\": true,\n      \"narrationCompleted\": true,\n      \"secondsPlayed\": 1,\n      \"secondsAvailable\": 1\n    }\n  ],\n  \"ctaType\": \"<string>\",\n  \"ctaLabel\": \"<string>\",\n  \"ctaUrl\": \"<string>\",\n  \"repMode\": true,\n  \"firstScreen\": \"intro\",\n  \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slidesViewed\": 1,\n  \"slidesTotal\": 1,\n  \"furthestSlideIndex\": 1,\n  \"totalDwellMs\": 1,\n  \"ctaConfigured\": true,\n  \"slidesNarrationStarted\": 1,\n  \"slidesNarrationCompleted\": 1,\n  \"totalSecondsPlayed\": 1,\n  \"totalSecondsAvailable\": 1,\n  \"qaVoiceAudioStarted\": 1,\n  \"qaVoiceAudioCompleted\": 1,\n  \"qaChatAudioStarted\": 1,\n  \"qaChatAudioCompleted\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.demand-iq.com/api/presentations/{presentationId}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"_token\": \"<string>\",\n  \"pointerCoarse\": true,\n  \"introShown\": true,\n  \"openSource\": \"<string>\",\n  \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slideId\": \"<string>\",\n  \"slideIndex\": 123,\n  \"durationMs\": 123,\n  \"skipped\": true,\n  \"views\": [\n    {\n      \"slideId\": \"<string>\",\n      \"slideIndex\": 123,\n      \"viewId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"durationMs\": 123,\n      \"skipped\": true,\n      \"narrationStarted\": true,\n      \"narrationCompleted\": true,\n      \"secondsPlayed\": 1,\n      \"secondsAvailable\": 1\n    }\n  ],\n  \"ctaType\": \"<string>\",\n  \"ctaLabel\": \"<string>\",\n  \"ctaUrl\": \"<string>\",\n  \"repMode\": true,\n  \"firstScreen\": \"intro\",\n  \"conversationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"slidesViewed\": 1,\n  \"slidesTotal\": 1,\n  \"furthestSlideIndex\": 1,\n  \"totalDwellMs\": 1,\n  \"ctaConfigured\": true,\n  \"slidesNarrationStarted\": 1,\n  \"slidesNarrationCompleted\": 1,\n  \"totalSecondsPlayed\": 1,\n  \"totalSecondsAvailable\": 1,\n  \"qaVoiceAudioStarted\": 1,\n  \"qaVoiceAudioCompleted\": 1,\n  \"qaChatAudioStarted\": 1,\n  \"qaChatAudioCompleted\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Path Parameters

presentationId

string<uuid>

required

Body

application/json

_token

string

required

HMAC authentication token

type

enum<string>

required

Event type. presentation_started is sent when the viewer presses Start on the intro screen, and records a presentation.started event. slides_shown is sent once per visit, the first time the viewer shows slides. AI Presentations records the first time slides are shown to a homeowner as the presentation's start, once, and later visits never change it. Visits by Demand IQ staff, by signed-in members of your organization, in rep mode, or from presentations whose opened emails all went to Demand IQ staff or your organization's own users don't record a start. Visits from link scanners, such as Microsoft Safe Links, are ignored. action_detection and action_execution are deprecated: they are acknowledged but not stored.

Available options:

presentation_opened,

presentation_started,

slides_shown,

slide_viewed,

slide_viewed_batch,

narration_played_batch,

cta_clicked,

last_slide_reached,

session_summary,

narration_session_summary,

action_detection,

action_execution

pointerCoarse

boolean

Whether the viewer's primary pointer is coarse, as reported by the (pointer: coarse) media query. Optional. Applies to presentation_opened. AI Presentations combines it with the request's user agent to classify the device as mobile, tablet, or desktop.

introShown

boolean

Whether this visit opened on the intro screen, so the viewer had a Start button to press. Optional. Applies to presentation_opened.

openSource

string

The utm_source value from the presentation link. Optional. Applies to presentation_opened. AI Presentations lower-cases it and keeps it only when it is 1 to 40 characters of a-z, 0-9, _, or -. Any other value is dropped.

viewId

string<uuid>

Per-visit ID generated by the viewer. Optional. AI Presentations stores one slide.viewed event per viewId. A later report with the same viewId updates that event's durationMs and skipped instead of adding a new event, as long as its durationMs is not lower. Omit it to record a new event for every report.

slideId

string

Slide ID. Required for slide_viewed and last_slide_reached. For last_slide_reached, send the presentation snapshot slide ID (the deck_presentation_slides row ID), not the deck slide ID. AI Presentations ignores any other ID and does not record presentation.completed. IDs longer than 100 characters are rejected with 400.

slideIndex

integer

durationMs

integer

skipped

boolean

Whether the viewer left the slide in under 2 seconds. A flag, not a filter: fast flips are still recorded as slide.viewed events, not as a separate skip event.

views

object[]

Batched entries. Required when type is slide_viewed_batch or narration_played_batch. Each entry counts against the rate limit individually. For slide_viewed_batch, each item is a slide view (slideId, slideIndex, optional viewId, durationMs, and skipped). For narration_played_batch, each item is a narration outcome (slideId, slideIndex, narrationStarted, narrationCompleted, secondsPlayed, and secondsAvailable, which is null when the audio duration was never known).

Maximum array length: 25

Show child attributes

ctaType

string

ctaLabel

string

ctaUrl

string

Destination URL of an external_link CTA. Send it only on cta_clicked events for that CTA type.

repMode

boolean

Whether a sales rep is driving the presentation. Client-supplied; the server cannot resolve it. Applies to cta_clicked, slides_shown, last_slide_reached, session_summary, and narration_session_summary.

firstScreen

enum<string>

The first screen the viewer showed on this visit. Client-supplied and optional. Applies to cta_clicked and session_summary. Any value outside the enum is rejected with 400.

Available options:

intro,

loading,

slides,

pending_data

Example:

"intro"

conversationId

string<uuid>

UUID that persists for the lifetime of the viewer's tab. Applies to session_summary and narration_session_summary.

slidesViewed

integer

Session-to-date count of distinct slides viewed. session_summary only.

Required range: x >= 0

slidesTotal

integer

Total number of slides in the presentation. session_summary only.

Required range: x >= 0

furthestSlideIndex

integer

Highest 0-based slide index reached in this session. session_summary only.

Required range: x >= 0

totalDwellMs

integer

Session-to-date wall-clock dwell across all slides, in milliseconds. session_summary only.

Required range: x >= 0

ctaConfigured

boolean

Whether the presentation has a CTA configured. session_summary only.

slidesNarrationStarted

integer

Session-to-date count of slides on which narration playback actually started. narration_session_summary only. > 0 is the derived read for "audio enabled".

Required range: x >= 0

slidesNarrationCompleted

integer

Session-to-date count of slides on which narration played to the end. narration_session_summary only.

Required range: x >= 0

totalSecondsPlayed

number

Session-to-date sum of secondsPlayed across all slides. narration_session_summary only.

Required range: x >= 0

totalSecondsAvailable

number

Session-to-date sum of secondsAvailable across all slides for which narration was attempted. narration_session_summary only.

Required range: x >= 0

qaVoiceAudioStarted

integer

Session-to-date count of Q&A answer audio plays that actually started, where the question was asked by voice. narration_session_summary only.

Required range: x >= 0

qaVoiceAudioCompleted

integer

Session-to-date count of Q&A answer audio plays that finished, where the question was asked by voice. Skips, errors, and rejected plays do not count. narration_session_summary only.

Required range: x >= 0

qaChatAudioStarted

integer

Session-to-date count of Q&A answer audio plays that actually started, where the question was typed. narration_session_summary only.

Required range: x >= 0

qaChatAudioCompleted

integer

Session-to-date count of Q&A answer audio plays that finished, where the question was typed. Skips, errors, and rejected plays do not count. narration_session_summary only.

Required range: x >= 0

Response

Event recorded

success

boolean