Skip to main content
GET
Origin report

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Query Parameters

since
string<date-time> | null

Start of the window, inclusive. Needs a timezone offset.

until
string<date-time> | null

End of the window, exclusive. Defaults to now.

group_by
enum<string>
default:channel

What a row stands for.

Available options:
channel,
source,
campaign,
adset,
ad,
capture_source,
entry_link,
whatsapp_number,
utm_campaign
date_basis
enum<string>
default:contact_created

Which creation date puts a record in the window.

Available options:
contact_created,
deal_created
captured_only
boolean
default:false

Leave out inferred (backfill), estimated (lookback) and repaired origins. Records without an origin stay in their own row.

sort_by
enum<string>
default:contacts
Available options:
contacts,
conversations,
deals,
won_deals,
won_value
limit
integer
default:25

Top rows kept; the rest are summed into one other row.

Required range: 1 <= x <= 100
channel
string | null

Drill-down parent: a channel row's key.

source
string | null

Drill-down parent: a source row's key.

campaign
string | null

Drill-down parent: a campaign row's key.

adset
string | null

Drill-down parent: an ad set row's key.

Response

Successful Response

attribution_rule
Attribution Rule · object
required

How each count is credited to an origin. Show it next to the numbers.

captured_only
boolean
required
date_basis
enum<string>
required
Available options:
contact_created,
deal_created
date_basis_rule
Date Basis Rule · object
required
filters
Filters · object
required

The parent keys the rows are restricted to.

group_by
enum<string>
required

What a row of the report stands for.

channel, source, campaign, adset and ad are the levels of a drill-down: ask for the next level with the parent rows' keys as filters. The other groupings are flat views of the same origins.

Available options:
channel,
source,
campaign,
adset,
ad,
capture_source,
entry_link,
whatsapp_number,
utm_campaign
limit
integer
required
next_group_by
enum<string> | null
required

The next level of the drill-down hierarchy; null at the last level and for flat groupings.

Available options:
channel,
source,
campaign,
adset,
ad,
capture_source,
entry_link,
whatsapp_number,
utm_campaign
period
OriginPeriod · object
required
rows
OriginRow · object[]
required

At most limit origin rows ordered by sort_by, then the remainder row, then the unknown row.

sort_by
enum<string>
required
Available options:
contacts,
conversations,
deals,
won_deals,
won_value
totals
OriginMetrics · object
required

Every row, the remainder and the unknown row summed.

value_rule
Value Rule · object
required

What won value is and which currency it is in.

object
string
default:origin_report
Allowed value: "origin_report"