Skip to main content
GET
Get a report

Authorizations

X-API-Key
string
header
required

Your workspace's API key. It starts with b2b_sk_.

Query Parameters

range
enum<string>
default:30d

The period to report on. custom needs from and to.

Available options:
7d,
30d,
90d,
custom
from
string<date> | null
to
string<date> | null
group_by
enum<string>
default:signal

How to group the report's rows.

Available options:
signal,
source,
campaign,
sender,
week,
step,
version,
person
workflow_id
string<uuid> | null

Only this campaign.

sender_id
string<uuid> | null

Only this sender.

include
string | null

Response

Success

range
object
required
group_by
enum<string>
required
Available options:
signal,
source,
campaign,
sender,
week,
step,
version,
person
insight
object
required
numbers
object
required
funnel
object
required
generated_at
string<date-time>
required
workflow_id
string<uuid> | null
workflow_name
string | null
rows
object[]
people
object[] | null
people_total
integer | null
average_reply_rate
number | null
min_people_for_rate
integer
default:50
mature_after_days
integer
default:7
workspace_name
string | null
group_by_options
object[]
sender_id
string<uuid> | null
sender_name
string | null
daily_sends
object[] | null