Skip to main content
POST
Event Time Series

Authorizations

api_key
string
header
required

Body

application/json

Event window, filters and grouping

startDate
string<date-time> | null

Start date for event time range (ISO 8601 format). Defaults to 14 days ago if not provided; the response's dataWindow echoes what was used.

endDate
string<date-time> | null

End date for event time range. Defaults to the time of the request, so events stamped in the future (a lost deal's placeholder close date, for example) are left out; pass an explicit later endDate to include them. The response's dataWindow echoes what was used.

filters
object

Filters to INCLUDE events: event type/category, company, contact, sentiment, call purpose, outcome, deal amount, library entity oIds (offerings, personas, segments, tags, use cases, competitors, alternatives, buying triggers, core features, objections, proof points, references), motion types, customer scope, custom extractor answers, and CRM deal context (opportunityIds, opportunityStatuses, dealMotions, dealTypes, dealStages, pipelinePhases, crmPipelines, minStalledDays). Deal filters AND on the same linked deal; values within one filter are OR'd. Events default to the activity feed's types, which leave out knowledge collection pages (docs, release notes): name their event types in eventTypes to read them.

exclude
object

Filters to EXCLUDE events matching these criteria (same shape as the entity/outcome match filters)

excludeTags
string[]

Exclude events matching any library entity that carries these reporting tag oIds. Use list_tag_groups to resolve tag oIds. Multiple tags are OR'd.

granularity
enum<string>
default:week

Bucket size, in UTC. Weeks start on Monday.

Available options:
day,
week,
month
includePreviousPeriod
boolean
default:false

Also compute the same thing for the period of equal length immediately before the window, returned under previous with its own dataWindow — for 'up or down vs the prior period'. The window's end defaults to now when endDate is omitted.

Response

Event Time Series

_metadata
object
required
dataWindow
object
required

The time span these numbers cover. Compare numbers from two tools only when their dataWindow kind and dates match.

granularity
enum<string>
required
Available options:
day,
week,
month
buckets
object[]
required

One entry per bucket across the window, oldest first; a bucket with no matching events is present with zeros. The first and last buckets are partial when the window does not start or end on a bucket boundary.

storedEvents
object
required

The earliest and latest events Octave stores for this workspace (any type, up to now). Observed bounds only: coverage is always 'unknown' because nothing here detects a gap in ingestion between them, and the first stored event may simply follow a quiet stretch. A zero inside the bounds is 'no matching stored events', not proof that nothing happened. Say so when a trend rests on it.

previous
object | null
required

The same series for the equal-length period just before the window; null unless includePreviousPeriod was set. Compare bucket i with bucket i.