Skip to main content
GET
Get engagement summary

Authorizations

Authorization
string
header
required

A Demand IQ API key or service token, passed in the Authorization: Bearer header.

Query Parameters

since
string<date-time>

Start of the window (inclusive), as an RFC 3339 timestamp. Timezone offsets are accepted. Provide with until, or omit both for the last 30 days.

until
string<date-time>

End of the window (exclusive), as an RFC 3339 timestamp. Must be after since. Provide with since, or omit both for the last 30 days.

deckId
string<uuid>

Limit the summary to one template. An empty value is treated as absent.

Response

Engagement summary

The seven engagement metrics for your organization over the requested window, plus the engagement funnel, visits per opened presentation, and delivery path counts.

window
object
required

The window the metrics cover: the requested since/until, or the last 30 days ending at request time.

deckId
string<uuid> | null
required

The template filter applied, or null when the summary covers all templates.

presentationsSent
object
required

Presentations successfully sent in the window.

opened
object
required

Presentations whose viewer page was loaded at least once. This is not the email-open signal. Includes opens by a signed-in member of your organization, so previewing your own presentation link counts as an open. rate.denominator is the number of presentations created in the window.

avgConsumption
object
required

Slides consumed out of the total slides in opened presentations created in the window. Unopened presentations are excluded, so this reflects viewing behavior rather than open rate. Slides viewed by a signed-in member of your organization are excluded.

ctaClicks
object
required

Call-to-action clicks. rate.denominator excludes presentations from templates with no call to action configured. Clicks by a signed-in member of your organization are excluded.

questionsAsked
object
required

Questions viewers asked during presentations. Questions asked by a signed-in member of your organization are excluded.

appointmentsBooked
object
required

Appointments booked from presentations.

contractsSigned
object
required

Contracts signed from presentations.

funnel
object
required

The Created → Completed funnel for presentations created in the window.

visits
object
required

Visits per opened presentation. AI Presentations splits a presentation's opens into separate visits wherever 30 minutes pass between opens. Each opened presentation counts as at least one visit. Treat these values as a lower bound, because opens are rate-limited.

deliveryPath
object
required

How opened presentations reached the viewer.