Skip to main content
Server path: /gleap-messaging-analytics | Type: Application | PCID required: Yes

Tools

ToolDescription
gleap_messaging_analytics_create_ai_contentCreate AI content
gleap_messaging_analytics_create_messageCreate a new message
gleap_messaging_analytics_create_message_templateCreate a new message template.
gleap_messaging_analytics_delete_messageDelete a comment
gleap_messaging_analytics_delete_message_templateDelete a message template
gleap_messaging_analytics_export_list_dataExport list data as CSV
gleap_messaging_analytics_find_by_content_idGet AI content by contentId
gleap_messaging_analytics_find_message_template_by_idFind a message template by ID.
gleap_messaging_analytics_find_message_templatesFind all message templates.
gleap_messaging_analytics_get_chart_dataGet bar chart data for various statistics
gleap_messaging_analytics_get_email_client_bounces_statsGet email client bounce statistics
gleap_messaging_analytics_get_email_client_usage_statsGet email client usage statistics
gleap_messaging_analytics_get_email_overview_statsGet email overview statistics
gleap_messaging_analytics_get_entryGet a single translatable entry
gleap_messaging_analytics_get_fact_dataGet fact data for various statistics
gleap_messaging_analytics_get_heatmap_dataGet heatmap data for activity patterns
gleap_messaging_analytics_get_list_dataGet list data for various statistics
gleap_messaging_analytics_get_messagesGet messages
gleap_messaging_analytics_get_raw_statisticsGet raw statistics data
gleap_messaging_analytics_list_entriesList all translatable entries
gleap_messaging_analytics_put_entryUpdate a translatable entry
gleap_messaging_analytics_remove_by_batch_idDelete AI content by batchId
gleap_messaging_analytics_remove_by_content_idDelete AI content by contentId
gleap_messaging_analytics_remove_old_batchesDelete old AI content batches
gleap_messaging_analytics_search_messagesSearch messages
gleap_messaging_analytics_suggest_faqFAQ suggestion
gleap_messaging_analytics_update_by_content_idUpdate AI content by contentId
gleap_messaging_analytics_update_messageUpdate a message
gleap_messaging_analytics_update_message_templateUpdate a message template.

gleap_messaging_analytics_create_ai_content

Create AI content Parameters:
ParameterTypeRequiredDefaultDescription
batchIdstringNoBatch Id
contentobjectYesThe content value
contentIdstringYesContent Id
readMoreLabelstringNoRead More Label
readMoreUrlstringNoRead More Url
titlestringYesThe title value
typestringYesThe type value

gleap_messaging_analytics_create_message

Create a new message Parameters:
ParameterTypeRequiredDefaultDescription
actionsany[]NoThe actions value
aiDataobjectNoAi Data
attachmentsany[]NoThe attachments value
botbooleanNoThe bot value
channelobjectNoThe channel value
commentobjectNoThe comment value
dataobjectNoThe data value
emailIdstringNoEmail Id
fallbackUserobjectNoFallback User
isNotebooleanNoIs Note
kaiChatbooleanNoKai Chat
messageRefstringNoMessage Ref
outboundstringNoThe outbound value
outboundSubjectstringNoOutbound Subject
outboundTemplatestringNoOutbound Template
ratingstringNoThe rating value
replyTostringNoReply To
sendToChannelbooleanNoSend To Channel
sessionstringNoThe session value
sessionNotificationsUnreadbooleanNoSession Notifications Unread
statusobjectNoThe status value
statusHistoryany[]NoStatus History
ticketstringNoThe ticket value
translatedDataobjectNoTranslated Data
typestringNoThe type value
userstringNoThe user value

gleap_messaging_analytics_create_message_template

Create a new message template. Parameters:
ParameterTypeRequiredDefaultDescription
actionsany[]NoThe actions value
attachmentsany[]NoThe attachments value
contentobjectYesThe content value
isPublicbooleanNoIs Public
lexorankstringYesThe lexorank value
titlestringYesThe title value
usersany[]NoThe users value

gleap_messaging_analytics_delete_message

Delete a comment Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage Id

gleap_messaging_analytics_delete_message_template

Delete a message template Parameters:
ParameterTypeRequiredDefaultDescription
messageTemplateIdstringYesMessage Template Id

gleap_messaging_analytics_export_list_data

Export list data as CSV Parameters:
ParameterTypeRequiredDefaultDescription
chartTypestringYes- Type of list data to export (e.g., TEAM_PERFORMANCE_LIST)
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNoAggs Type
startDatestringNoStart date for filtering
endDatestringNoEnd date for filtering
createdAtstringNoCreated At
updatedAtstringNoUpdated At
useWorkingHoursbooleanNo- Whether to use working hours calculations

gleap_messaging_analytics_find_by_content_id

Get AI content by contentId Parameters:
ParameterTypeRequiredDefaultDescription
contentIdstringYesContent Id

gleap_messaging_analytics_find_message_template_by_id

Find a message template by ID. Parameters:
ParameterTypeRequiredDefaultDescription
messageTemplateIdstringYesMessage Template Id

gleap_messaging_analytics_find_message_templates

Find all message templates. Parameters:
ParameterTypeRequiredDefaultDescription
limitnumberNoMaximum number of results to return
skipnumberNoThe skip value
searchTermstringNoSearch term to filter results
visibilitystringNoThe visibility value
withCountbooleanNoWith Count

gleap_messaging_analytics_get_chart_data

Get bar chart data for various statistics Parameters:
ParameterTypeRequiredDefaultDescription
chartTypestringYes- Type of chart data to retrieve (e.g., NEW_TICKETS_COUNT, MEDIAN_FIRST_RESPONSE_TIME)
timezonestringNo- Timezone for date calculations (e.g., “America/New_York”)
groupIntervalstringNo- Grouping interval (“day”, “month”, “year”)
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNo- Aggregation type (“MEDIAN”, “AVERAGE”)
startDatestringNo- Start date for filtering (ISO format)
endDatestringNo- End date for filtering (ISO format)
createdAtstringNoCreated At
updatedAtstringNoUpdated At

gleap_messaging_analytics_get_email_client_bounces_stats

Get email client bounce statistics Parameters:
ParameterTypeRequiredDefaultDescription
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNoAggs Type
startDatestringNo- Start date for filtering (ISO format)
endDatestringNo- End date for filtering (ISO format)
createdAtstringNoCreated At
updatedAtstringNoUpdated At
emailServerKeystringNo- Specific email server key

gleap_messaging_analytics_get_email_client_usage_stats

Get email client usage statistics Parameters:
ParameterTypeRequiredDefaultDescription
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNoAggs Type
startDatestringNo- Start date for filtering (ISO format)
endDatestringNo- End date for filtering (ISO format)
createdAtstringNoCreated At
updatedAtstringNoUpdated At
emailServerKeystringNo- Specific email server key

gleap_messaging_analytics_get_email_overview_stats

Get email overview statistics Parameters:
ParameterTypeRequiredDefaultDescription
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNoAggs Type
startDatestringNo- Start date for filtering (ISO format)
endDatestringNo- End date for filtering (ISO format)
createdAtstringNoCreated At
updatedAtstringNoUpdated At
emailServerKeystringNo- Specific email server key

gleap_messaging_analytics_get_entry

Get a single translatable entry Parameters:
ParameterTypeRequiredDefaultDescription
entryIdstringYesEntry Id
languagestringNoThe language value

gleap_messaging_analytics_get_fact_data

Get fact data for various statistics Parameters:
ParameterTypeRequiredDefaultDescription
chartTypestringYes- Type of fact data to retrieve (e.g., NEW_TICKETS_COUNT, MEDIAN_TIME_TO_CLOSE)
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNo- Aggregation type (“MEDIAN”, “AVERAGE”)
startDatestringNo- Start date for filtering (ISO format)
endDatestringNo- End date for filtering (ISO format)
createdAtstringNoCreated At
updatedAtstringNoUpdated At

gleap_messaging_analytics_get_heatmap_data

Get heatmap data for activity patterns Parameters:
ParameterTypeRequiredDefaultDescription
chartTypestringYes- Type of heatmap data (BUSIEST_HOURS_PER_WEEKDAY, BUSIEST_COMMENTS_PER_WEEKDAY)
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNoAggs Type
startDatestringNo- Start date for filtering (ISO format)
endDatestringNo- End date for filtering (ISO format)
createdAtstringNoCreated At
updatedAtstringNoUpdated At

gleap_messaging_analytics_get_list_data

Get list data for various statistics Parameters:
ParameterTypeRequiredDefaultDescription
chartTypestringYes- Type of list data to retrieve (e.g., TEAM_PERFORMANCE_LIST, ARTICLE_SEARCH_RESULT_LIST)
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNo- Number of records to skip (pagination)
limitnumberNo- Maximum number of records to return
groupedBystringNoGrouped By
aggsTypestringNoAggs Type
startDatestringNoStart date for filtering
endDatestringNoEnd date for filtering
createdAtstringNoCreated At
updatedAtstringNoUpdated At
useWorkingHoursbooleanNo- Whether to use working hours calculations

gleap_messaging_analytics_get_messages

Get messages

gleap_messaging_analytics_get_raw_statistics

Get raw statistics data Parameters:
ParameterTypeRequiredDefaultDescription
timezonestringNo- Timezone for date calculations
groupIntervalstringNoGroup Interval
skipnumberNoThe skip value
limitnumberNoMaximum number of results to return
groupedBystringNoGrouped By
aggsTypestringNoAggs Type
startDatestringNo- Start date for filtering (ISO format)
endDatestringNo- End date for filtering (ISO format)
createdAtstringNoCreated At
updatedAtstringNoUpdated At
typestringNo- Type of raw data to retrieve

gleap_messaging_analytics_list_entries

List all translatable entries Parameters:
ParameterTypeRequiredDefaultDescription
typestringNoSupported 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:
ParameterTypeRequiredDefaultDescription
entryIdstringYesEntry Id
fieldsobjectYesKey-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.
languagestringYesThe 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:
ParameterTypeRequiredDefaultDescription
batchIdstringYesBatch Id

gleap_messaging_analytics_remove_by_content_id

Delete AI content by contentId Parameters:
ParameterTypeRequiredDefaultDescription
contentIdstringYesContent Id

gleap_messaging_analytics_remove_old_batches

Delete old AI content batches Parameters:
ParameterTypeRequiredDefaultDescription
currentBatchIdstringYesCurrent Batch Id
typestringNoThe type value

gleap_messaging_analytics_search_messages

Search messages Parameters:
ParameterTypeRequiredDefaultDescription
searchTermstringYesSearch term to filter results

gleap_messaging_analytics_suggest_faq

FAQ suggestion Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage Id
acceptbooleanYesThe accept value

gleap_messaging_analytics_update_by_content_id

Update AI content by contentId Parameters:
ParameterTypeRequiredDefaultDescription
contentIdstringYesContent Id
batchIdstringNoBatch Id
contentobjectYesThe content value
readMoreLabelstringNoRead More Label
readMoreUrlstringNoRead More Url
titlestringYesThe title value
typestringYesThe type value

gleap_messaging_analytics_update_message

Update a message Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage Id
actionsany[]NoThe actions value
aiDataobjectNoAi Data
attachmentsany[]NoThe attachments value
botbooleanNoThe bot value
channelobjectNoThe channel value
commentobjectNoThe comment value
dataobjectNoThe data value
emailIdstringNoEmail Id
fallbackUserobjectNoFallback User
isNotebooleanNoIs Note
kaiChatbooleanNoKai Chat
messageRefstringNoMessage Ref
outboundstringNoThe outbound value
outboundSubjectstringNoOutbound Subject
outboundTemplatestringNoOutbound Template
ratingstringNoThe rating value
replyTostringNoReply To
sendToChannelbooleanNoSend To Channel
sessionstringNoThe session value
sessionNotificationsUnreadbooleanNoSession Notifications Unread
statusobjectNoThe status value
statusHistoryany[]NoStatus History
ticketstringNoThe ticket value
translatedDataobjectNoTranslated Data
typestringNoThe type value
userstringNoThe user value

gleap_messaging_analytics_update_message_template

Update a message template. Parameters:
ParameterTypeRequiredDefaultDescription
messageTemplateIdstringYesMessage Template Id
actionsany[]NoThe actions value
attachmentsany[]NoThe attachments value
contentobjectYesThe content value
isPublicbooleanNoIs Public
lexorankstringYesThe lexorank value
titlestringYesThe title value
usersany[]NoThe users value