Skip to main content
POST
Get Revenue Metrics

Authorizations

api_key
string
header
required

Body

application/json

Close-date window and optional breakdown

closeDateFrom
string

Start of the window: only deals that closed on or after this day (YYYY-MM-DD, UTC). Omit for all time.

Pattern: ^\d{4}-\d{2}-\d{2}$
closeDateTo
string

End of the window: only deals that closed on or before this day (YYYY-MM-DD, UTC), the whole day included. Defaults to asOf.

Pattern: ^\d{4}-\d{2}-\d{2}$
asOf
string

The day the numbers are read as of (YYYY-MM-DD, UTC), the whole day included. Defaults to today. Deals closed on or before it count, and a deal dated after it has not closed yet.

Pattern: ^\d{4}-\d{2}-\d{2}$
groupBy
enum<string>

Break the window's numbers down by segment (the account's segment), use_case, persona, offering (product, service or solution) or core_feature (what the deal's conversations raised; a deal can fall under several, so rows overlap), tag (the tags in the tagGroupId group carried by the library entities the deal is linked to; a deal falls under each tag once, so rows overlap), or owner (the CRM deal owner). Omit for totals only.

Available options:
segment,
use_case,
persona,
owner,
offering,
core_feature,
tag
tagGroupId
string

Only with groupBy "tag": the oId of the tag group to break down by (list_tag_groups returns them). A tag group applies to one kind of library entity (segment, use case, persona, product, service, solution or core feature); a deal falls under a tag when the entity of that kind it is linked to carries the tag, and in the "No tag in group" row when none does (or "No calls or emails" when it has no recorded conversations).

Minimum string length: 1

Response

Revenue metrics for the window

_metadata
object
required
asOf
string
required

The day the numbers are read as of.

window
object
required
rule
object
required
homeCurrency
string | null
required
totals
object
required
groups
object | null
required
coverage
object
required
warnings
string[]
required

Reasons to read the numbers with care: a partial sync, a rule value that matches nothing, a grouping that could not be read.

summary
string

One-line reading of this result for a person. The fields beside it are the data; read them, not this, for figures.