/gleap-messaging-analytics | Type: Application | PCID required: Yes
Tools
gleap_messaging_analytics_create_ai_content
Create AI content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
batchId | string | No | — | Batch Id |
content | object | Yes | — | The content value |
contentId | string | Yes | — | Content Id |
readMoreLabel | string | No | — | Read More Label |
readMoreUrl | string | No | — | Read More Url |
title | string | Yes | — | The title value |
type | string | Yes | — | The type value |
gleap_messaging_analytics_create_message
Create a new message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
actions | any[] | No | — | The actions value |
aiData | object | No | — | Ai Data |
attachments | any[] | No | — | The attachments value |
bot | boolean | No | — | The bot value |
channel | object | No | — | The channel value |
comment | object | No | — | The comment value |
data | object | No | — | The data value |
emailId | string | No | — | Email Id |
fallbackUser | object | No | — | Fallback User |
isNote | boolean | No | — | Is Note |
kaiChat | boolean | No | — | Kai Chat |
messageRef | string | No | — | Message Ref |
outbound | string | No | — | The outbound value |
outboundSubject | string | No | — | Outbound Subject |
outboundTemplate | string | No | — | Outbound Template |
rating | string | No | — | The rating value |
replyTo | string | No | — | Reply To |
sendToChannel | boolean | No | — | Send To Channel |
session | string | No | — | The session value |
sessionNotificationsUnread | boolean | No | — | Session Notifications Unread |
status | object | No | — | The status value |
statusHistory | any[] | No | — | Status History |
ticket | string | No | — | The ticket value |
translatedData | object | No | — | Translated Data |
type | string | No | — | The type value |
user | string | No | — | The user value |
gleap_messaging_analytics_create_message_template
Create a new message template. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
actions | any[] | No | — | The actions value |
attachments | any[] | No | — | The attachments value |
content | object | Yes | — | The content value |
isPublic | boolean | No | — | Is Public |
lexorank | string | Yes | — | The lexorank value |
title | string | Yes | — | The title value |
users | any[] | No | — | The users value |
gleap_messaging_analytics_delete_message
Delete a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message Id |
gleap_messaging_analytics_delete_message_template
Delete a message template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageTemplateId | string | Yes | — | Message Template Id |
gleap_messaging_analytics_export_list_data
Export list data as CSV Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chartType | string | Yes | — | - Type of list data to export (e.g., TEAM_PERFORMANCE_LIST) |
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | Aggs Type |
startDate | string | No | — | Start date for filtering |
endDate | string | No | — | End date for filtering |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
useWorkingHours | boolean | No | — | - Whether to use working hours calculations |
gleap_messaging_analytics_find_by_content_id
Get AI content by contentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentId | string | Yes | — | Content Id |
gleap_messaging_analytics_find_message_template_by_id
Find a message template by ID. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageTemplateId | string | Yes | — | Message Template Id |
gleap_messaging_analytics_find_message_templates
Find all message templates. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | number | No | — | Maximum number of results to return |
skip | number | No | — | The skip value |
searchTerm | string | No | — | Search term to filter results |
visibility | string | No | — | The visibility value |
withCount | boolean | No | — | With Count |
gleap_messaging_analytics_get_chart_data
Get bar chart data for various statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chartType | string | Yes | — | - Type of chart data to retrieve (e.g., NEW_TICKETS_COUNT, MEDIAN_FIRST_RESPONSE_TIME) |
timezone | string | No | — | - Timezone for date calculations (e.g., “America/New_York”) |
groupInterval | string | No | — | - Grouping interval (“day”, “month”, “year”) |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | - Aggregation type (“MEDIAN”, “AVERAGE”) |
startDate | string | No | — | - Start date for filtering (ISO format) |
endDate | string | No | — | - End date for filtering (ISO format) |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
gleap_messaging_analytics_get_email_client_bounces_stats
Get email client bounce statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | Aggs Type |
startDate | string | No | — | - Start date for filtering (ISO format) |
endDate | string | No | — | - End date for filtering (ISO format) |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
emailServerKey | string | No | — | - Specific email server key |
gleap_messaging_analytics_get_email_client_usage_stats
Get email client usage statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | Aggs Type |
startDate | string | No | — | - Start date for filtering (ISO format) |
endDate | string | No | — | - End date for filtering (ISO format) |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
emailServerKey | string | No | — | - Specific email server key |
gleap_messaging_analytics_get_email_overview_stats
Get email overview statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | Aggs Type |
startDate | string | No | — | - Start date for filtering (ISO format) |
endDate | string | No | — | - End date for filtering (ISO format) |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
emailServerKey | string | No | — | - Specific email server key |
gleap_messaging_analytics_get_entry
Get a single translatable entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryId | string | Yes | — | Entry Id |
language | string | No | — | The language value |
gleap_messaging_analytics_get_fact_data
Get fact data for various statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chartType | string | Yes | — | - Type of fact data to retrieve (e.g., NEW_TICKETS_COUNT, MEDIAN_TIME_TO_CLOSE) |
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | - Aggregation type (“MEDIAN”, “AVERAGE”) |
startDate | string | No | — | - Start date for filtering (ISO format) |
endDate | string | No | — | - End date for filtering (ISO format) |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
gleap_messaging_analytics_get_heatmap_data
Get heatmap data for activity patterns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chartType | string | Yes | — | - Type of heatmap data (BUSIEST_HOURS_PER_WEEKDAY, BUSIEST_COMMENTS_PER_WEEKDAY) |
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | Aggs Type |
startDate | string | No | — | - Start date for filtering (ISO format) |
endDate | string | No | — | - End date for filtering (ISO format) |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
gleap_messaging_analytics_get_list_data
Get list data for various statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chartType | string | Yes | — | - Type of list data to retrieve (e.g., TEAM_PERFORMANCE_LIST, ARTICLE_SEARCH_RESULT_LIST) |
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | - Number of records to skip (pagination) |
limit | number | No | — | - Maximum number of records to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | Aggs Type |
startDate | string | No | — | Start date for filtering |
endDate | string | No | — | End date for filtering |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
useWorkingHours | boolean | No | — | - Whether to use working hours calculations |
gleap_messaging_analytics_get_messages
Get messagesgleap_messaging_analytics_get_raw_statistics
Get raw statistics data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timezone | string | No | — | - Timezone for date calculations |
groupInterval | string | No | — | Group Interval |
skip | number | No | — | The skip value |
limit | number | No | — | Maximum number of results to return |
groupedBy | string | No | — | Grouped By |
aggsType | string | No | — | Aggs Type |
startDate | string | No | — | - Start date for filtering (ISO format) |
endDate | string | No | — | - End date for filtering (ISO format) |
createdAt | string | No | — | Created At |
updatedAt | string | No | — | Updated At |
type | string | No | — | - Type of raw data to retrieve |
gleap_messaging_analytics_list_entries
List all translatable entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | No | — | Supported translatable entity types. Use as the type query parameter on GET /translations/entries to filter results. |
gleap_messaging_analytics_put_entry
Update a translatable entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entryId | string | Yes | — | Entry Id |
fields | object | Yes | — | Key-value pairs of translatable fields. Keys depend on the entity type (e.g., “title”, “description”, “content” for articles). Values are plain text or HTML strings depending on the field type. |
language | string | Yes | — | The language code to set the translation for (e.g., “en”, “de”, “fr”). |
gleap_messaging_analytics_remove_by_batch_id
Delete AI content by batchId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
batchId | string | Yes | — | Batch Id |
gleap_messaging_analytics_remove_by_content_id
Delete AI content by contentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentId | string | Yes | — | Content Id |
gleap_messaging_analytics_remove_old_batches
Delete old AI content batches Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
currentBatchId | string | Yes | — | Current Batch Id |
type | string | No | — | The type value |
gleap_messaging_analytics_search_messages
Search messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
searchTerm | string | Yes | — | Search term to filter results |
gleap_messaging_analytics_suggest_faq
FAQ suggestion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message Id |
accept | boolean | Yes | — | The accept value |
gleap_messaging_analytics_update_by_content_id
Update AI content by contentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentId | string | Yes | — | Content Id |
batchId | string | No | — | Batch Id |
content | object | Yes | — | The content value |
readMoreLabel | string | No | — | Read More Label |
readMoreUrl | string | No | — | Read More Url |
title | string | Yes | — | The title value |
type | string | Yes | — | The type value |
gleap_messaging_analytics_update_message
Update a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message Id |
actions | any[] | No | — | The actions value |
aiData | object | No | — | Ai Data |
attachments | any[] | No | — | The attachments value |
bot | boolean | No | — | The bot value |
channel | object | No | — | The channel value |
comment | object | No | — | The comment value |
data | object | No | — | The data value |
emailId | string | No | — | Email Id |
fallbackUser | object | No | — | Fallback User |
isNote | boolean | No | — | Is Note |
kaiChat | boolean | No | — | Kai Chat |
messageRef | string | No | — | Message Ref |
outbound | string | No | — | The outbound value |
outboundSubject | string | No | — | Outbound Subject |
outboundTemplate | string | No | — | Outbound Template |
rating | string | No | — | The rating value |
replyTo | string | No | — | Reply To |
sendToChannel | boolean | No | — | Send To Channel |
session | string | No | — | The session value |
sessionNotificationsUnread | boolean | No | — | Session Notifications Unread |
status | object | No | — | The status value |
statusHistory | any[] | No | — | Status History |
ticket | string | No | — | The ticket value |
translatedData | object | No | — | Translated Data |
type | string | No | — | The type value |
user | string | No | — | The user value |
gleap_messaging_analytics_update_message_template
Update a message template. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageTemplateId | string | Yes | — | Message Template Id |
actions | any[] | No | — | The actions value |
attachments | any[] | No | — | The attachments value |
content | object | Yes | — | The content value |
isPublic | boolean | No | — | Is Public |
lexorank | string | Yes | — | The lexorank value |
title | string | Yes | — | The title value |
users | any[] | No | — | The users value |

