Skip to main content
GET
List Events

Authorizations

api_key
string
header
required

Query Parameters

startDate
string<date-time>
required

Start of the time range (ISO 8601 datetime)

endDate
string<date-time>

End of the time range (ISO 8601 datetime). Defaults to now.

limit
integer | null
default:20

Maximum number of events to return (max 100)

Required range: x <= 100
offset
integer | null
default:0

Number of events to skip for pagination

insightOId
string

Scope results to the events one Insight covers, resolved the same way that Insight's own run resolves them. Other filters narrow further within the Insight's events.

Example:

"rcfg_XVPcS3dLZFqzfQIfSeCpk"

eventTypes
enum<string>[]

Filter by event types

Available options:
EMAIL_SENT,
EMAIL_REPLY_RECEIVED,
CALL_TRANSCRIPT,
DEAL_WON,
DEAL_LOST,
OPPORTUNITY_CREATED,
MEETING_BOOKED,
RESOURCE_INDEXED,
RESOURCE_REINDEXED,
PROJECT_UPDATE,
TASK_COMPLETED,
ENTITY_CREATED,
ENTITY_UPDATED,
SOCIAL_MESSAGE_SENT,
SOCIAL_MESSAGE_RECEIVED,
SOCIAL_CONNECTION_SENT,
SOCIAL_CONNECTION_ACCEPTED,
AD_SET_PUBLISHED,
AD_PERFORMANCE_SNAPSHOT,
BULK_IMPORT_SUMMARY,
PROCESSING_NOT_APPLICABLE,
PROVIDER_EVENT_TYPE_UNKNOWN,
UNKNOWN
eventCategories
enum<string>[]

Filter by event categories

Available options:
EMAIL,
CALL,
CRM,
RESOURCE,
REVISION,
SOCIAL,
ADS,
PRODUCT,
UNKNOWN
callPurposes
enum<string>[]

Filter calls by classified purpose (single value, repeated param, or comma-separated)

Available options:
DISCOVERY,
DEMO,
TECHNICAL_EVALUATION,
WORKING_SESSION,
NEGOTIATION_PRICING,
ONBOARDING,
CHECK_IN_SUCCESS,
QBR_RENEWAL,
EXPANSION_UPSELL,
ESCALATION_CHURN_RISK,
SUPPORT,
INTERNAL_SYNC,
OTHER
offerings
string[]

Only events with a finding matched to one of these offering (product, service or solution) oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
personas
string[]

Only events with a finding matched to one of these persona oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
segments
string[]

Only events with a finding matched to one of these segment oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
useCases
string[]

Only events with a finding matched to one of these use case oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
references
string[]

Only events with a finding matched to one of these reference customer oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
competitors
string[]

Only events with a finding matched to one of these competitor oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
alternatives
string[]

Only events with a finding matched to one of these alternative oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
buyingTriggers
string[]

Only events with a finding matched to one of these buying trigger oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
coreFeatures
string[]

Only events with a finding matched to one of these core feature oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
objections
string[]

Only events with a finding matched to one of these objection oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
proofPoints
string[]

Only events with a finding matched to one of these proof point oIds (single value, repeated param, or comma-separated)

Maximum array length: 100
Minimum string length: 1
entityMatchAll
boolean
default:false

When true, an event must match every entity oId given rather than any one per filter. Defaults to false.

tags
string[]

Only events matching a library entity that carries one of these reporting tag oIds, from any tag group on any entity type (see tag-group/list). Multiple tags are OR'd.

Maximum array length: 100
Minimum string length: 1
excludeTags
string[]

Exclude events matching a library entity that carries one of these reporting tag oIds. Multiple tags are OR'd.

Maximum array length: 100
Minimum string length: 1

Response

200 - application/json

List of events for the workspace

data
object
required