Skip to main content
GET
Report the comment-to-DM funnel

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency
page
integer
default:1

Pagination page number

Required range: x >= 1
limit
integer
default:25

Rows to return per page

Required range: 1 <= x <= 100
programId
string<uuid>

Narrow the report to one program

groupBy
enum<string>
default:program

How to group the rows

Available options:
program,
account,
post,
day
sortBy
enum<string>

Field to sort rows by. Defaults to date for groupBy=day and linkClicks otherwise. date needs groupBy=day

Available options:
linkClicks,
uniqueClickers,
dmsSent,
optIns,
date
sortOrder
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
fromDate
string<date>

Count events on or after this day (YYYY-MM-DD, America/New_York)

toDate
string<date>

Count events on or before this day (YYYY-MM-DD, America/New_York)

Response

Comment-to-DM funnel returned successfully

data
object[]
page
integer
limit
integer
total
integer
totalPages
integer
groupBy
enum<string>
Available options:
program,
account,
post,
day
fromDate
string<date> | null
toDate
string<date> | null
summary
object
sortBy
enum<string>
Available options:
linkClicks,
uniqueClickers,
dmsSent,
optIns,
date
sortOrder
enum<string>
Available options:
asc,
desc