Skip to content

Get Pipeline By Source

GET
/reports/pipeline-by-source

New pipeline by source channel for a period against the one before it, over the deals the key can see.

Authorizations

Parameters

Query Parameters

model

Credit the first, last or any touch channel.

string
default: first
Allowed values: first last any

Credit the first, last or any touch channel.

from
Any of:
string format: date

First day (default: 30 days ago).

to
Any of:
string format: date

Last day (default: today).

owner_id
Any of:
Array<string>

Only deals owned by these people. Repeatable; a merged rep option is one value.

pipeline_id
Any of:
Array<string>

Only these pipelines. Repeatable.

sequence_id
Any of:
string
<= 100 characters
tz

IANA time zone; days and months are local to it.

string
default: UTC <= 64 characters

IANA time zone; days and months are local to it.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Pipeline by source: per-channel, monthly, meeting-path, assisted and per-rep figures for two periods.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string