Parameters
- batches: {
events: (
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
entityId: string;
entityKind: "Experience"
| "ExperienceFragment";
entityKindId?: string;
entryIds?: string[];
messageId: string;
optimizationId?: string;
originalTimestamp: string;
parameters?: Record<string, JSONType>;
parentExperienceId?: string;
parentVariantId?: string;
sentAt: string;
timestamp: string;
type: "exo_node_view";
userId?: string;
variantId?: string;
variantIndex?: number;
viewDurationMs: number;
viewId: string;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
componentId: string;
componentType?: "Entry" | "Variable";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
experienceId?: string;
messageId: string;
originalTimestamp: string;
sentAt: string;
timestamp: string;
type: "component";
userId?: string;
variantIndex?: number;
viewDurationMs?: number;
viewId?: string;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
componentId: string;
componentType?: "Entry" | "Variable";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
experienceId?: string;
messageId: string;
originalTimestamp: string;
sentAt: string;
timestamp: string;
type: "component_click";
userId?: string;
variantIndex?: number;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
entityId: string;
entityKind: "Experience"
| "ExperienceFragment";
entityKindId?: string;
entryIds?: string[];
messageId: string;
optimizationId?: string;
originalTimestamp: string;
parameters?: Record<string, JSONType>;
parentExperienceId?: string;
parentVariantId?: string;
sentAt: string;
timestamp: string;
type: "exo_node_click";
userId?: string;
variantId?: string;
variantIndex?: number;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
entityId: string;
entityKind: "Experience"
| "ExperienceFragment";
entityKindId?: string;
entryIds?: string[];
hoverDurationMs: number;
hoverId: string;
messageId: string;
optimizationId?: string;
originalTimestamp: string;
parameters?: Record<string, JSONType>;
parentExperienceId?: string;
parentVariantId?: string;
sentAt: string;
timestamp: string;
type: "exo_node_hover";
userId?: string;
variantId?: string;
variantIndex?: number;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
componentId: string;
componentType?: "Entry" | "Variable";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
experienceId?: string;
hoverDurationMs: number;
hoverId: string;
messageId: string;
originalTimestamp: string;
sentAt: string;
timestamp: string;
type: "component_hover";
userId?: string;
variantIndex?: number;
}
)[];
profile: {
audiences: string[];
id: string;
jurisdiction?: "US"
| "EU";
location: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
random: number;
session: {
activeSessionLength: number;
averageSessionLength: number;
count: number;
id?: string;
isReturningVisitor: boolean;
landingPage: {
path: string;
query: Record<string, string | string[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
};
stableId: string;
traits: Record<string, JSONType>;
};
}[]events: (
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
entityId: string;
entityKind: "Experience"
| "ExperienceFragment";
entityKindId?: string;
entryIds?: string[];
messageId: string;
optimizationId?: string;
originalTimestamp: string;
parameters?: Record<string, JSONType>;
parentExperienceId?: string;
parentVariantId?: string;
sentAt: string;
timestamp: string;
type: "exo_node_view";
userId?: string;
variantId?: string;
variantIndex?: number;
viewDurationMs: number;
viewId: string;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
componentId: string;
componentType?: "Entry" | "Variable";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
experienceId?: string;
messageId: string;
originalTimestamp: string;
sentAt: string;
timestamp: string;
type: "component";
userId?: string;
variantIndex?: number;
viewDurationMs?: number;
viewId?: string;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
componentId: string;
componentType?: "Entry" | "Variable";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
experienceId?: string;
messageId: string;
originalTimestamp: string;
sentAt: string;
timestamp: string;
type: "component_click";
userId?: string;
variantIndex?: number;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
entityId: string;
entityKind: "Experience"
| "ExperienceFragment";
entityKindId?: string;
entryIds?: string[];
messageId: string;
optimizationId?: string;
originalTimestamp: string;
parameters?: Record<string, JSONType>;
parentExperienceId?: string;
parentVariantId?: string;
sentAt: string;
timestamp: string;
type: "exo_node_click";
userId?: string;
variantId?: string;
variantIndex?: number;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
entityId: string;
entityKind: "Experience"
| "ExperienceFragment";
entityKindId?: string;
entryIds?: string[];
hoverDurationMs: number;
hoverId: string;
messageId: string;
optimizationId?: string;
originalTimestamp: string;
parameters?: Record<string, JSONType>;
parentExperienceId?: string;
parentVariantId?: string;
sentAt: string;
timestamp: string;
type: "exo_node_hover";
userId?: string;
variantId?: string;
variantIndex?: number;
}
| {
anonymousId?: string;
channel: "server"
| "mobile"
| "web";
componentId: string;
componentType?: "Entry" | "Variable";
context: {
app?: { name: string; version: string };
campaign: {
content?: string;
medium?: string;
name?: string;
source?: string;
term?: string;
};
gdpr?: { isConsentGiven: boolean };
library: { name: string; version: string };
locale?: string;
location?: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
page?: {
path: string;
query: Record<string, string | (...)[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
screen?: { name: string; [key: string]: JSONType };
userAgent?: string;
};
experienceId?: string;
hoverDurationMs: number;
hoverId: string;
messageId: string;
originalTimestamp: string;
sentAt: string;
timestamp: string;
type: "component_hover";
userId?: string;
variantIndex?: number;
}
)[]
profile: {
audiences: string[];
id: string;
jurisdiction?: "US" | "EU";
location: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
};
random: number;
session: {
activeSessionLength: number;
averageSessionLength: number;
count: number;
id?: string;
isReturningVisitor: boolean;
landingPage: {
path: string;
query: Record<string, string | string[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
};
stableId: string;
traits: Record<string, JSONType>;
}
audiences: string[]
id: string
Optionaljurisdiction?: "US" | "EU"
location: {
city?: string;
continent?: string;
coordinates?: { latitude: number; longitude: number };
country?: string;
countryCode?: string;
postalCode?: string;
region?: string;
regionCode?: string;
timezone?: string;
}
Optionalcity?: string
Optionalcontinent?: string
Optionalcoordinates?: { latitude: number; longitude: number }
latitude: number
longitude: number
Optionalcountry?: string
OptionalcountryCode?: string
OptionalpostalCode?: string
Optionalregion?: string
OptionalregionCode?: string
Optionaltimezone?: string
random: number
session: {
activeSessionLength: number;
averageSessionLength: number;
count: number;
id?: string;
isReturningVisitor: boolean;
landingPage: {
path: string;
query: Record<string, string | string[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
};
}
activeSessionLength: number
averageSessionLength: number
count: number
Optionalid?: string
isReturningVisitor: boolean
landingPage: {
path: string;
query: Record<string, string | string[]>;
referrer: string;
search: string;
title?: string;
url: string;
[key: string]: JSONType;
}
path: string
query: Record<string, string | string[]>
referrer: string
search: string
Optionaltitle?: string
url: string
stableId: string
traits: Record<string, JSONType>
- options: InsightsApiClientRequestOptions = {}
Returns Promise<boolean>
true when the event batch is successfully queued by the beacon
sender or a direct request is successfully sent, false otherwise.
Client for sending analytics and insights events to the Ninetailed Insights API.
Remarks
This client is optimized for sending batched events, optionally using a custom beacon-like sender for last-chance lifecycle delivery.
Example
Extends
ApiClientBase.