Skip to content

Create Object Report Api

POST
/reports

Save a report owned by this credential. Private by default; a shared one (visibility: "org") needs objects:manage and current Admin access. Fields the credential cannot see are unknown to it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
chart_type
required
string
Allowed values: table bar line funnel stage_over_time time_in_stage
config
required

What a report computes. timezone (an IANA name) fixes how dates are bucketed and what “end of day” means; when absent the organization’s time zone applies (never the server’s).

object
filters
Array<object>
<= 10 items

One filter on a field of the source, or (with relationship_slug) on a field of the contact, company or deal the source points at: the record passes when a linked record it may see matches. in is “is any of” and takes a list of values.

object
attribute_slug
required
string
>= 1 characters <= 100 characters
operator
required
string
Allowed values: eq ne gt gte lt lte contains starts_with is_null is_not_null in
relationship_slug
Any of:
string
>= 1 characters <= 100 characters
value
group_by
Array<object>
<= 3 items

One group-by. attribute: a field of the source (a date or timestamp field needs a grain); related_attribute: a field of the ONE record a single-valued relationship points at; created_at: the record’s creation time, bucketed by grain.

object
attribute_slug
Any of:
string
<= 100 characters
grain
Any of:
string
Allowed values: day week month quarter year
kind
string
default: attribute
Allowed values: attribute related_attribute created_at
relationship_slug
Any of:
string
<= 100 characters
measures
Array<object>
<= 10 items

One measure. count counts each record once (COUNT DISTINCT record id); sum / avg / min / max read a numeric field’s value; related_count counts the live records a relationship links each record to.

object
attribute_slug
Any of:
string
<= 100 characters
kind
required
string
Allowed values: count sum avg min max related_count
label
Any of:
string
>= 1 characters <= 120 characters
relationship_slug
Any of:
string
<= 100 characters
range
Any of:

The calendar range a stage-over-time report snapshots, one column per grain period end (in the report’s time zone).

object
from
required
string format: date
grain
string
default: month
Allowed values: day week month quarter year
to
required
string format: date
stage
Any of:

The stage field and the ORDERED stages a funnel, stage-over-time or time-in-stage report walks.

object
attribute_slug
required
string
>= 1 characters <= 100 characters
order
required
Array<string>
>= 2 items <= 20 items
timezone
Any of:
string
<= 64 characters
description
Any of:
string
<= 2000 characters
object_slug
required
string
>= 1 characters <= 100 characters
title
required
string
>= 1 characters <= 200 characters
visibility
string
default: private
Allowed values: private org

Responses

201

Successful Response

object
data
required
object
can_delete
required
boolean
can_edit
required
boolean
chart_type
required
string
Allowed values: table bar line funnel stage_over_time time_in_stage
config
required
object
key
additional properties
any
created_at
required
string format: date-time
description
Any of:
string
id
required
string format: uuid
is_owner
required
boolean
owner
required
object
id
Any of:
string
is_you
boolean
name
Any of:
string
restricted
Array<object>

A part of a report the viewer may not see. Hidden means ABSENT: it carries no title, no object name, no type and no reason, only its position id (m0 the first measure, g0 the first group-by, f0 the first filter, stage the stage field), so a client can lock that slot in place.

object
id
required
string
restricted
boolean
default: true
restricted_count
integer
revision
required
integer
source
required
object
is_archived
boolean
kind
required
string
Allowed values: object process_list
plural_noun
required
string
singular_noun
required
string
slug
required
string
title
required
string
updated_at
required
string format: date-time
visibility
required
string
Allowed values: private org
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