Analytics apiQueryEvents
Query Events
Authorization
AuthorizationRequiredBearer <token>The API key for a Web integration. For more details, see authentication documentation
In: header
AuthorizationRequiredBearer <token>The API key for an API integration. For more details, see authentication documentation
In: header
Request Body
application/jsonRequiredNote: The maximum size of the request body is 2 MB.
selectarray<EventsSelection>groupByarray<EventsGroupBy>whereEventsFilterorderByarray<Events OrderBy Schema>notesstringNotes are not persisted, but may be useful for your debugging purposes
Maximum length:
80Response Body
Response body for QueryEvents query endpoint
statusRequiredstringStatus of the response
Value in:
"ok"dataRequiredobjectData object containing QueryEvents query results and pagination information
/**
* Response body for QueryEvents query endpoint
*/
export interface Response {
/**
* Status of the response
*/
status: "ok";
data: QueryEventsResponseData;
}
/**
* Data object containing QueryEvents query results and pagination information
*/
export interface QueryEventsResponseData {
result: EventsResultItem[];
/**
* Total number of results matching the query
*/
total: number;
/**
* Number of results per page
*/
pageSize: number;
/**
* Number of results in the current response
*/
count: number;
}
export interface EventsResultItem {
id?: string;
organizationId?: string;
messageId?: string;
conversationId?: string;
createdAt?: string;
projectId?: string | null;
integrationId?: string | null;
eventType?: string;
type?: string;
searchQuery?: string;
properties?: {
[k: string]: string;
} | null;
userProperties?: {
[k: string]: string;
} | null;
sum?: number;
count?: number;
avg?: number;
min?: number;
max?: number;
id_hour?: string;
id_day?: string;
id_week?: string;
id_month?: string;
organizationId_hour?: string;
organizationId_day?: string;
organizationId_week?: string;
organizationId_month?: string;
messageId_hour?: string;
messageId_day?: string;
messageId_week?: string;
messageId_month?: string;
conversationId_hour?: string;
conversationId_day?: string;
conversationId_week?: string;
conversationId_month?: string;
createdAt_hour?: string;
createdAt_day?: string;
createdAt_week?: string;
createdAt_month?: string;
projectId_hour?: string;
projectId_day?: string;
projectId_week?: string;
projectId_month?: string;
integrationId_hour?: string;
integrationId_day?: string;
integrationId_week?: string;
integrationId_month?: string;
eventType_hour?: string;
eventType_day?: string;
eventType_week?: string;
eventType_month?: string;
type_hour?: string;
type_day?: string;
type_week?: string;
type_month?: string;
searchQuery_hour?: string;
searchQuery_day?: string;
searchQuery_week?: string;
searchQuery_month?: string;
properties_hour?: string;
properties_day?: string;
properties_week?: string;
properties_month?: string;
userProperties_hour?: string;
userProperties_day?: string;
userProperties_week?: string;
userProperties_month?: string;
sum_id?: number;
sum_organizationId?: number;
sum_messageId?: number;
sum_conversationId?: number;
sum_createdAt?: number;
sum_projectId?: number;
sum_integrationId?: number;
sum_eventType?: number;
sum_type?: number;
sum_searchQuery?: number;
sum_properties?: number;
sum_userProperties?: number;
count_id?: number;
count_organizationId?: number;
count_messageId?: number;
count_conversationId?: number;
count_createdAt?: number;
count_projectId?: number;
count_integrationId?: number;
count_eventType?: number;
count_type?: number;
count_searchQuery?: number;
count_properties?: number;
count_userProperties?: number;
avg_id?: number;
avg_organizationId?: number;
avg_messageId?: number;
avg_conversationId?: number;
avg_createdAt?: number;
avg_projectId?: number;
avg_integrationId?: number;
avg_eventType?: number;
avg_type?: number;
avg_searchQuery?: number;
avg_properties?: number;
avg_userProperties?: number;
min_id?: number;
min_organizationId?: number;
min_messageId?: number;
min_conversationId?: number;
min_createdAt?: number;
min_projectId?: number;
min_integrationId?: number;
min_eventType?: number;
min_type?: number;
min_searchQuery?: number;
min_properties?: number;
min_userProperties?: number;
max_id?: number;
max_organizationId?: number;
max_messageId?: number;
max_conversationId?: number;
max_createdAt?: number;
max_projectId?: number;
max_integrationId?: number;
max_eventType?: number;
max_type?: number;
max_searchQuery?: number;
max_properties?: number;
max_userProperties?: number;
"sum_properties.userId"?: number;
"sum_properties.supportAgentName"?: number;
"sum_userProperties.userId"?: number;
"sum_userProperties.supportAgentName"?: number;
"count_properties.userId"?: number;
"count_properties.supportAgentName"?: number;
"count_userProperties.userId"?: number;
"count_userProperties.supportAgentName"?: number;
"countDistinct_properties.userId"?: number;
"countDistinct_properties.supportAgentName"?: number;
"countDistinct_userProperties.userId"?: number;
"countDistinct_userProperties.supportAgentName"?: number;
"avg_properties.userId"?: number;
"avg_properties.supportAgentName"?: number;
"avg_userProperties.userId"?: number;
"avg_userProperties.supportAgentName"?: number;
"min_properties.userId"?: number;
"min_properties.supportAgentName"?: number;
"min_userProperties.userId"?: number;
"min_userProperties.supportAgentName"?: number;
"max_properties.userId"?: number;
"max_properties.supportAgentName"?: number;
"max_userProperties.userId"?: number;
"max_userProperties.supportAgentName"?: number;
"properties.userId"?: string | null;
"properties.supportAgentName"?: string | null;
"userProperties.userId"?: string | null;
"userProperties.supportAgentName"?: string | null;
}
curl -X POST "https://api.analytics.inkeep.com/query/events" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"select": [
{
"type": "aggregation",
"aggregation": "sum",
"field": "id",
"path": [
"string"
]
}
],
"groupBy": [
{
"field": "id",
"path": [
"string"
],
"includeInSelect": true
}
],
"where": {
"condition": {
"field": "id",
"operator": "eq",
"value": "string"
}
},
"orderBy": [
{
"field": "id",
"direction": "asc"
}
],
"notes": "Count of events by type"
}'{
"status": "ok",
"data": {
"result": [
{
"id": "string",
"organizationId": "string",
"messageId": "string",
"conversationId": "string",
"createdAt": "string",
"projectId": "string",
"integrationId": "string",
"eventType": "string",
"type": "string",
"searchQuery": "string",
"properties": {
"property1": "string",
"property2": "string"
},
"userProperties": {
"property1": "string",
"property2": "string"
},
"sum": 0,
"count": 0,
"avg": 0,
"min": 0,
"max": 0,
"id_hour": "string",
"id_day": "string",
"id_week": "string",
"id_month": "string",
"organizationId_hour": "string",
"organizationId_day": "string",
"organizationId_week": "string",
"organizationId_month": "string",
"messageId_hour": "string",
"messageId_day": "string",
"messageId_week": "string",
"messageId_month": "string",
"conversationId_hour": "string",
"conversationId_day": "string",
"conversationId_week": "string",
"conversationId_month": "string",
"createdAt_hour": "string",
"createdAt_day": "string",
"createdAt_week": "string",
"createdAt_month": "string",
"projectId_hour": "string",
"projectId_day": "string",
"projectId_week": "string",
"projectId_month": "string",
"integrationId_hour": "string",
"integrationId_day": "string",
"integrationId_week": "string",
"integrationId_month": "string",
"eventType_hour": "string",
"eventType_day": "string",
"eventType_week": "string",
"eventType_month": "string",
"type_hour": "string",
"type_day": "string",
"type_week": "string",
"type_month": "string",
"searchQuery_hour": "string",
"searchQuery_day": "string",
"searchQuery_week": "string",
"searchQuery_month": "string",
"properties_hour": "string",
"properties_day": "string",
"properties_week": "string",
"properties_month": "string",
"userProperties_hour": "string",
"userProperties_day": "string",
"userProperties_week": "string",
"userProperties_month": "string",
"sum_id": 0,
"sum_organizationId": 0,
"sum_messageId": 0,
"sum_conversationId": 0,
"sum_createdAt": 0,
"sum_projectId": 0,
"sum_integrationId": 0,
"sum_eventType": 0,
"sum_type": 0,
"sum_searchQuery": 0,
"sum_properties": 0,
"sum_userProperties": 0,
"count_id": 0,
"count_organizationId": 0,
"count_messageId": 0,
"count_conversationId": 0,
"count_createdAt": 0,
"count_projectId": 0,
"count_integrationId": 0,
"count_eventType": 0,
"count_type": 0,
"count_searchQuery": 0,
"count_properties": 0,
"count_userProperties": 0,
"avg_id": 0,
"avg_organizationId": 0,
"avg_messageId": 0,
"avg_conversationId": 0,
"avg_createdAt": 0,
"avg_projectId": 0,
"avg_integrationId": 0,
"avg_eventType": 0,
"avg_type": 0,
"avg_searchQuery": 0,
"avg_properties": 0,
"avg_userProperties": 0,
"min_id": 0,
"min_organizationId": 0,
"min_messageId": 0,
"min_conversationId": 0,
"min_createdAt": 0,
"min_projectId": 0,
"min_integrationId": 0,
"min_eventType": 0,
"min_type": 0,
"min_searchQuery": 0,
"min_properties": 0,
"min_userProperties": 0,
"max_id": 0,
"max_organizationId": 0,
"max_messageId": 0,
"max_conversationId": 0,
"max_createdAt": 0,
"max_projectId": 0,
"max_integrationId": 0,
"max_eventType": 0,
"max_type": 0,
"max_searchQuery": 0,
"max_properties": 0,
"max_userProperties": 0,
"sum_properties.userId": 0,
"sum_properties.supportAgentName": 0,
"sum_userProperties.userId": 0,
"sum_userProperties.supportAgentName": 0,
"count_properties.userId": 0,
"count_properties.supportAgentName": 0,
"count_userProperties.userId": 0,
"count_userProperties.supportAgentName": 0,
"countDistinct_properties.userId": 0,
"countDistinct_properties.supportAgentName": 0,
"countDistinct_userProperties.userId": 0,
"countDistinct_userProperties.supportAgentName": 0,
"avg_properties.userId": 0,
"avg_properties.supportAgentName": 0,
"avg_userProperties.userId": 0,
"avg_userProperties.supportAgentName": 0,
"min_properties.userId": 0,
"min_properties.supportAgentName": 0,
"min_userProperties.userId": 0,
"min_userProperties.supportAgentName": 0,
"max_properties.userId": 0,
"max_properties.supportAgentName": 0,
"max_userProperties.userId": 0,
"max_userProperties.supportAgentName": 0,
"properties.userId": "string",
"properties.supportAgentName": "string",
"userProperties.userId": "string",
"userProperties.supportAgentName": "string"
}
],
"total": 0,
"pageSize": 0,
"count": 0
}
}