> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# gleap-messaging-analytics

> Gleap Messaging & Analytics - messages, templates, AI content, statistics, and translations

**Server path:** `/gleap-messaging-analytics` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                    | Description                               |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [`gleap_messaging_analytics_create_ai_content`](#gleap_messaging_analytics_create_ai_content)                           | Create AI content                         |
| [`gleap_messaging_analytics_create_message`](#gleap_messaging_analytics_create_message)                                 | Create a new message                      |
| [`gleap_messaging_analytics_create_message_template`](#gleap_messaging_analytics_create_message_template)               | Create a new message template.            |
| [`gleap_messaging_analytics_delete_message`](#gleap_messaging_analytics_delete_message)                                 | Delete a comment                          |
| [`gleap_messaging_analytics_delete_message_template`](#gleap_messaging_analytics_delete_message_template)               | Delete a message template                 |
| [`gleap_messaging_analytics_export_list_data`](#gleap_messaging_analytics_export_list_data)                             | Export list data as CSV                   |
| [`gleap_messaging_analytics_find_by_content_id`](#gleap_messaging_analytics_find_by_content_id)                         | Get AI content by contentId               |
| [`gleap_messaging_analytics_find_message_template_by_id`](#gleap_messaging_analytics_find_message_template_by_id)       | Find a message template by ID.            |
| [`gleap_messaging_analytics_find_message_templates`](#gleap_messaging_analytics_find_message_templates)                 | Find all message templates.               |
| [`gleap_messaging_analytics_get_chart_data`](#gleap_messaging_analytics_get_chart_data)                                 | Get bar chart data for various statistics |
| [`gleap_messaging_analytics_get_email_client_bounces_stats`](#gleap_messaging_analytics_get_email_client_bounces_stats) | Get email client bounce statistics        |
| [`gleap_messaging_analytics_get_email_client_usage_stats`](#gleap_messaging_analytics_get_email_client_usage_stats)     | Get email client usage statistics         |
| [`gleap_messaging_analytics_get_email_overview_stats`](#gleap_messaging_analytics_get_email_overview_stats)             | Get email overview statistics             |
| [`gleap_messaging_analytics_get_entry`](#gleap_messaging_analytics_get_entry)                                           | Get a single translatable entry           |
| [`gleap_messaging_analytics_get_fact_data`](#gleap_messaging_analytics_get_fact_data)                                   | Get fact data for various statistics      |
| [`gleap_messaging_analytics_get_heatmap_data`](#gleap_messaging_analytics_get_heatmap_data)                             | Get heatmap data for activity patterns    |
| [`gleap_messaging_analytics_get_list_data`](#gleap_messaging_analytics_get_list_data)                                   | Get list data for various statistics      |
| [`gleap_messaging_analytics_get_messages`](#gleap_messaging_analytics_get_messages)                                     | Get messages                              |
| [`gleap_messaging_analytics_get_raw_statistics`](#gleap_messaging_analytics_get_raw_statistics)                         | Get raw statistics data                   |
| [`gleap_messaging_analytics_list_entries`](#gleap_messaging_analytics_list_entries)                                     | List all translatable entries             |
| [`gleap_messaging_analytics_put_entry`](#gleap_messaging_analytics_put_entry)                                           | Update a translatable entry               |
| [`gleap_messaging_analytics_remove_by_batch_id`](#gleap_messaging_analytics_remove_by_batch_id)                         | Delete AI content by batchId              |
| [`gleap_messaging_analytics_remove_by_content_id`](#gleap_messaging_analytics_remove_by_content_id)                     | Delete AI content by contentId            |
| [`gleap_messaging_analytics_remove_old_batches`](#gleap_messaging_analytics_remove_old_batches)                         | Delete old AI content batches             |
| [`gleap_messaging_analytics_search_messages`](#gleap_messaging_analytics_search_messages)                               | Search messages                           |
| [`gleap_messaging_analytics_suggest_faq`](#gleap_messaging_analytics_suggest_faq)                                       | FAQ suggestion                            |
| [`gleap_messaging_analytics_update_by_content_id`](#gleap_messaging_analytics_update_by_content_id)                     | Update AI content by contentId            |
| [`gleap_messaging_analytics_update_message`](#gleap_messaging_analytics_update_message)                                 | Update a message                          |
| [`gleap_messaging_analytics_update_message_template`](#gleap_messaging_analytics_update_message_template)               | Update a message template.                |

***

## gleap\_messaging\_analytics\_create\_ai\_content

Create AI content

**Parameters:**

| Parameter       | Type   | Required | Default | Description       |
| --------------- | ------ | -------- | ------- | ----------------- |
| `project`       | string | Yes      | —       | The project value |
| `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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "batchId": {
        "type": "string",
        "description": "Batch Id"
      },
      "content": {
        "description": "The content value"
      },
      "contentId": {
        "type": "string",
        "description": "Content Id"
      },
      "readMoreLabel": {
        "type": "string",
        "description": "Read More Label"
      },
      "readMoreUrl": {
        "type": "string",
        "description": "Read More Url"
      },
      "title": {
        "type": "string",
        "description": "The title value"
      },
      "type": {
        "type": "string",
        "description": "The type value"
      }
    },
    "required": [
      "PCID",
      "project",
      "content",
      "contentId",
      "title",
      "type"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_create\_message

Create a new message

**Parameters:**

| Parameter                    | Type      | Required | Default | Description                  |
| ---------------------------- | --------- | -------- | ------- | ---------------------------- |
| `project`                    | string    | Yes      | —       | The project value            |
| `actions`                    | object\[] | No       | —       | The actions value            |
| `aiData`                     | object    | No       | —       | Ai Data                      |
| `attachments`                | object\[] | 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               |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "actions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "data": {
              "description": "The data value"
            },
            "type": {
              "type": "string",
              "description": "The type value"
            }
          },
          "required": [
            "type"
          ]
        },
        "description": "The actions value"
      },
      "aiData": {
        "description": "Ai Data"
      },
      "attachments": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "The name value"
            },
            "url": {
              "type": "string",
              "description": "The url value"
            },
            "type": {
              "type": "string",
              "description": "The type value"
            }
          },
          "required": [
            "name",
            "url"
          ]
        },
        "description": "The attachments value"
      },
      "bot": {
        "type": "boolean",
        "description": "The bot value"
      },
      "channel": {
        "type": "object",
        "description": "The channel value",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "type": {
            "type": "string",
            "description": "The type value"
          },
          "messageId": {
            "type": "string",
            "description": "Message Id"
          }
        },
        "required": [
          "id"
        ]
      },
      "comment": {
        "description": "The comment value"
      },
      "data": {
        "description": "The data value"
      },
      "emailId": {
        "type": "string",
        "description": "Email Id"
      },
      "fallbackUser": {
        "type": "object",
        "description": "Fallback User",
        "properties": {
          "username": {
            "type": "string",
            "description": "The username value"
          },
          "email": {
            "type": "string",
            "description": "The email value"
          },
          "imageUrl": {
            "type": "string",
            "description": "Image Url"
          }
        }
      },
      "isNote": {
        "type": "boolean",
        "description": "Is Note"
      },
      "kaiChat": {
        "type": "boolean",
        "description": "Kai Chat"
      },
      "messageRef": {
        "type": "string",
        "description": "Message Ref"
      },
      "outbound": {
        "type": "string",
        "description": "The outbound value"
      },
      "outboundSubject": {
        "type": "string",
        "description": "Outbound Subject"
      },
      "outboundTemplate": {
        "type": "string",
        "description": "Outbound Template"
      },
      "rating": {
        "type": "string",
        "description": "The rating value"
      },
      "replyTo": {
        "type": "string",
        "description": "Reply To"
      },
      "sendToChannel": {
        "type": "boolean",
        "description": "Send To Channel"
      },
      "session": {
        "type": "string",
        "description": "The session value"
      },
      "sessionNotificationsUnread": {
        "type": "boolean",
        "description": "Session Notifications Unread"
      },
      "status": {
        "description": "The status value"
      },
      "statusHistory": {
        "type": "array",
        "description": "Status History"
      },
      "ticket": {
        "type": "string",
        "description": "The ticket value"
      },
      "translatedData": {
        "description": "Translated Data"
      },
      "type": {
        "type": "string",
        "description": "The type value"
      },
      "user": {
        "type": "string",
        "description": "The user value"
      }
    },
    "required": [
      "PCID",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_create\_message\_template

Create a new message template.

**Parameters:**

| Parameter     | Type      | Required | Default | Description           |
| ------------- | --------- | -------- | ------- | --------------------- |
| `project`     | string    | Yes      | —       | The project value     |
| `actions`     | object\[] | 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`       | string\[] | No       | —       | The users value       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "actions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "data": {
              "description": "The data value"
            },
            "type": {
              "type": "string",
              "description": "The type value"
            }
          },
          "required": [
            "type"
          ]
        },
        "description": "The actions value"
      },
      "attachments": {
        "type": "array",
        "description": "The attachments value"
      },
      "content": {
        "description": "The content value"
      },
      "isPublic": {
        "type": "boolean",
        "description": "Is Public"
      },
      "lexorank": {
        "type": "string",
        "description": "The lexorank value"
      },
      "title": {
        "type": "string",
        "description": "The title value"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The users value"
      }
    },
    "required": [
      "PCID",
      "project",
      "content",
      "lexorank",
      "title"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_delete\_message

Delete a comment

**Parameters:**

| Parameter   | Type   | Required | Default | Description       |
| ----------- | ------ | -------- | ------- | ----------------- |
| `messageId` | string | Yes      | —       | Message Id        |
| `project`   | string | Yes      | —       | The project value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messageId": {
        "type": "string",
        "description": "Message Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      }
    },
    "required": [
      "PCID",
      "messageId",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_delete\_message\_template

Delete a message template

**Parameters:**

| Parameter           | Type   | Required | Default | Description         |
| ------------------- | ------ | -------- | ------- | ------------------- |
| `messageTemplateId` | string | Yes      | —       | Message Template Id |
| `project`           | string | Yes      | —       | The project value   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messageTemplateId": {
        "type": "string",
        "description": "Message Template Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      }
    },
    "required": [
      "PCID",
      "messageTemplateId",
      "project"
    ]
  }
  ```
</Expandable>

***

## 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                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "chartType": {
        "type": "string",
        "description": "- Type of list data to export (e.g., TEAM_PERFORMANCE_LIST)",
        "enum": [
          "AVERAGE_RATING_PER_USER_RESULT_LIST",
          "TEAM_PERFORMANCE_LIST",
          "ARTICLE_SEARCH_RESULT_LIST",
          "ARTICLE_SEARCH_WITH_NO_RESULT_LIST",
          "ARTICLE_VIEW_STATISTICS_LIST",
          "TICKETS_WITH_RATING_LIST",
          "LIVE_AGENTS_TEAM",
          "SNAPSHOT_TICKETS",
          "LATEST_NEGATIVE_AI_FEEDBACK",
          "SLA_REPORTS_LIST"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "Aggs Type"
      },
      "startDate": {
        "type": "string",
        "description": "Start date for filtering"
      },
      "endDate": {
        "type": "string",
        "description": "End date for filtering"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      },
      "useWorkingHours": {
        "type": "boolean",
        "description": "- Whether to use working hours calculations"
      }
    },
    "required": [
      "PCID",
      "chartType"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_find\_by\_content\_id

Get AI content by contentId

**Parameters:**

| Parameter   | Type   | Required | Default | Description       |
| ----------- | ------ | -------- | ------- | ----------------- |
| `contentId` | string | Yes      | —       | Content Id        |
| `project`   | string | Yes      | —       | The project value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "contentId": {
        "type": "string",
        "description": "Content Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      }
    },
    "required": [
      "PCID",
      "contentId",
      "project"
    ]
  }
  ```
</Expandable>

***

## 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 |
| `project`           | string | Yes      | —       | The project value   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messageTemplateId": {
        "type": "string",
        "description": "Message Template Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      }
    },
    "required": [
      "PCID",
      "messageTemplateId",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_find\_message\_templates

Find all message templates.

**Parameters:**

| Parameter    | Type    | Required | Default | Description                         |
| ------------ | ------- | -------- | ------- | ----------------------------------- |
| `project`    | string  | Yes      | —       | The project value                   |
| `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                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "searchTerm": {
        "type": "string",
        "description": "Search term to filter results"
      },
      "visibility": {
        "type": "string",
        "description": "The visibility value"
      },
      "withCount": {
        "type": "boolean",
        "description": "With Count"
      }
    },
    "required": [
      "PCID",
      "project"
    ]
  }
  ```
</Expandable>

***

## 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                                                                                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "chartType": {
        "type": "string",
        "description": "- Type of chart data to retrieve (e.g., NEW_TICKETS_COUNT, MEDIAN_FIRST_RESPONSE_TIME)",
        "enum": [
          "NEW_TICKETS_COUNT",
          "TICKET_CLOSE_COUNT",
          "REPLIES_COUNT",
          "MEDIAN_FIRST_RESPONSE_TIME",
          "MEDIAN_TIME_TO_CLOSE",
          "MEDIAN_REPLY_TIME",
          "MEDIAN_CONVERSATION_RATING",
          "MEDIAN_REASSIGNMENT_COUNT",
          "MEDIAN_TIME_TO_FIRST_ASSIGNMENT",
          "HELP_CENTER_ARTICLE_VIEW_COUNT",
          "NEWS_VIEW_COUNT",
          "CHANGELOG_VIEW_COUNT",
          "KAI_INVOLVED",
          "MESSAGE_COUNT",
          "AI_QUESTIONS_ASKED_COUNT",
          "CUSTOMER_SUPPORT_REQUESTED",
          "SLA_BREACHES_COUNT",
          "SLA_STARTED_COUNT",
          "TICKET_CREATION_GROUPED_BY_DATE_AND_TAGS",
          "AI_RATING_GROUPED_BY_DATE"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations (e.g., \"America/New_York\")"
      },
      "groupInterval": {
        "type": "string",
        "description": "- Grouping interval (\"day\", \"month\", \"year\")",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "- Aggregation type (\"MEDIAN\", \"AVERAGE\")"
      },
      "startDate": {
        "type": "string",
        "description": "- Start date for filtering (ISO format)"
      },
      "endDate": {
        "type": "string",
        "description": "- End date for filtering (ISO format)"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      }
    },
    "required": [
      "PCID",
      "chartType"
    ]
  }
  ```
</Expandable>

***

## 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             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "Aggs Type"
      },
      "startDate": {
        "type": "string",
        "description": "- Start date for filtering (ISO format)"
      },
      "endDate": {
        "type": "string",
        "description": "- End date for filtering (ISO format)"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      },
      "emailServerKey": {
        "type": "string",
        "description": "- Specific email server key"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "Aggs Type"
      },
      "startDate": {
        "type": "string",
        "description": "- Start date for filtering (ISO format)"
      },
      "endDate": {
        "type": "string",
        "description": "- End date for filtering (ISO format)"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      },
      "emailServerKey": {
        "type": "string",
        "description": "- Specific email server key"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "Aggs Type"
      },
      "startDate": {
        "type": "string",
        "description": "- Start date for filtering (ISO format)"
      },
      "endDate": {
        "type": "string",
        "description": "- End date for filtering (ISO format)"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      },
      "emailServerKey": {
        "type": "string",
        "description": "- Specific email server key"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_get\_entry

Get a single translatable entry

**Parameters:**

| Parameter  | Type   | Required | Default | Description        |
| ---------- | ------ | -------- | ------- | ------------------ |
| `project`  | string | Yes      | —       | The project value  |
| `entryId`  | string | Yes      | —       | Entry Id           |
| `language` | string | No       | —       | The language value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "entryId": {
        "type": "string",
        "description": "Entry Id"
      },
      "language": {
        "type": "string",
        "description": "The language value"
      }
    },
    "required": [
      "PCID",
      "project",
      "entryId"
    ]
  }
  ```
</Expandable>

***

## 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                                                                           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "chartType": {
        "type": "string",
        "description": "- Type of fact data to retrieve (e.g., NEW_TICKETS_COUNT, MEDIAN_TIME_TO_CLOSE)",
        "enum": [
          "MEDIAN_FIRST_RESPONSE_TIME",
          "MEDIAN_TIME_TO_CLOSE",
          "TICKET_CLOSE_COUNT",
          "MEDIAN_CONVERSATION_RATING",
          "TICKET_MEDIAN_REPLY_TIME",
          "MEDIAN_FIRST_ASSIGNMENT_TIME",
          "NEW_TICKETS_COUNT",
          "TICKET_COUNT_BY_QUERY",
          "TICKET_REPLIES_COUNT",
          "TICKET_WORKED_ON_COUNT",
          "TICKETS_WITH_OTHER_STATUS_THEN_OPEN_OR_CLOSED_COUNT",
          "HELP_CENTER_ARTICLE_VIEW_COUNT",
          "NEWS_VIEW_COUNT",
          "CHANGELOG_VIEW_COUNT",
          "KAI_ANSWERED_COUNT",
          "KAI_NO_ANSWER_COUNT",
          "KAI_ROUTED_TO_AGENT_RATE_COUNT",
          "KAI_DEFLECTION_RATE",
          "KAI_DEFLECTION_RATE_UNIQUE_USERS",
          "KAI_ROUTED_TO_AGENT_RATE_UNIQUE_USERS",
          "KAI_ROUTED_TO_AGENT_RATE",
          "KAI_POSITIVE_FEEDBACK_RATE",
          "KAI_NEGATIVE_FEEDBACK_RATE",
          "KAI_POSITIVE_FEEDBACK_PERCENTAGE",
          "SNAPSHOT_AGENTS_ONLINE_COUNT",
          "SNAPSHOT_OPEN_TICKETS",
          "MESSAGE_COUNT",
          "AI_QUESTIONS_ASKED_COUNT",
          "SLA_BREACHES_COUNT",
          "SLA_COMPLIANCE",
          "SLA_NOT_COMPLIANCE",
          "SLA_NO_BREACHES_COUNT",
          "TICKETS_WITHOUT_COMMENTS_RATE",
          "KAI_DEFLECTION_COUNT",
          "KAI_ROUTED_TO_AGENT_COUNT"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "- Aggregation type (\"MEDIAN\", \"AVERAGE\")"
      },
      "startDate": {
        "type": "string",
        "description": "- Start date for filtering (ISO format)"
      },
      "endDate": {
        "type": "string",
        "description": "- End date for filtering (ISO format)"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      }
    },
    "required": [
      "PCID",
      "chartType"
    ]
  }
  ```
</Expandable>

***

## 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                                                                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "chartType": {
        "type": "string",
        "description": "- Type of heatmap data (BUSIEST_HOURS_PER_WEEKDAY, BUSIEST_COMMENTS_PER_WEEKDAY)",
        "enum": [
          "BUSIEST_HOURS_PER_WEEKDAY",
          "BUSIEST_COMMENTS_PER_WEEKDAY"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "Aggs Type"
      },
      "startDate": {
        "type": "string",
        "description": "- Start date for filtering (ISO format)"
      },
      "endDate": {
        "type": "string",
        "description": "- End date for filtering (ISO format)"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      }
    },
    "required": [
      "PCID",
      "chartType"
    ]
  }
  ```
</Expandable>

***

## 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                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "chartType": {
        "type": "string",
        "description": "- Type of list data to retrieve (e.g., TEAM_PERFORMANCE_LIST, ARTICLE_SEARCH_RESULT_LIST)",
        "enum": [
          "AVERAGE_RATING_PER_USER_RESULT_LIST",
          "TEAM_PERFORMANCE_LIST",
          "ARTICLE_SEARCH_RESULT_LIST",
          "ARTICLE_SEARCH_WITH_NO_RESULT_LIST",
          "ARTICLE_VIEW_STATISTICS_LIST",
          "TICKETS_WITH_RATING_LIST",
          "LIVE_AGENTS_TEAM",
          "SNAPSHOT_TICKETS",
          "LATEST_NEGATIVE_AI_FEEDBACK",
          "SLA_REPORTS_LIST"
        ]
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "- Number of records to skip (pagination)"
      },
      "limit": {
        "type": "number",
        "description": "- Maximum number of records to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "Aggs Type"
      },
      "startDate": {
        "type": "string",
        "description": "Start date for filtering"
      },
      "endDate": {
        "type": "string",
        "description": "End date for filtering"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      },
      "useWorkingHours": {
        "type": "boolean",
        "description": "- Whether to use working hours calculations"
      }
    },
    "required": [
      "PCID",
      "chartType"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_get\_messages

Get messages

**Parameters:**

| Parameter | Type   | Required | Default | Description       |
| --------- | ------ | -------- | ------- | ----------------- |
| `project` | string | Yes      | —       | The project value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      }
    },
    "required": [
      "PCID",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_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          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "timezone": {
        "type": "string",
        "description": "- Timezone for date calculations"
      },
      "groupInterval": {
        "type": "string",
        "description": "Group Interval",
        "enum": [
          "day",
          "month",
          "year"
        ]
      },
      "skip": {
        "type": "number",
        "description": "The skip value"
      },
      "limit": {
        "type": "number",
        "description": "Maximum number of results to return"
      },
      "groupedBy": {
        "type": "string",
        "description": "Grouped By"
      },
      "aggsType": {
        "type": "string",
        "description": "Aggs Type"
      },
      "startDate": {
        "type": "string",
        "description": "- Start date for filtering (ISO format)"
      },
      "endDate": {
        "type": "string",
        "description": "- End date for filtering (ISO format)"
      },
      "createdAt": {
        "type": "string",
        "description": "Created At"
      },
      "updatedAt": {
        "type": "string",
        "description": "Updated At"
      },
      "type": {
        "type": "string",
        "description": "- Type of raw data to retrieve"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_list\_entries

List all translatable entries

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                                            |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |
| `project` | string | Yes      | —       | The project value                                                                                                      |
| `type`    | string | No       | —       | Supported translatable entity types. Use as the `type` query parameter on GET /translations/entries to filter results. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "type": {
        "type": "string",
        "description": "Supported translatable entity types. Use as the `type` query parameter on GET /translations/entries to filter results.",
        "enum": [
          "article",
          "collection",
          "emailtemplate",
          "statictranslation"
        ]
      }
    },
    "required": [
      "PCID",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_put\_entry

Update a translatable entry

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                                                                                                                                                                       |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project`  | string | Yes      | —       | The project value                                                                                                                                                                                 |
| `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").                                                                                                                            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "entryId": {
        "type": "string",
        "description": "Entry Id"
      },
      "fields": {
        "description": "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": {
        "type": "string",
        "description": "The language code to set the translation for (e.g., \"en\", \"de\", \"fr\")."
      }
    },
    "required": [
      "PCID",
      "project",
      "entryId",
      "fields",
      "language"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_remove\_by\_batch\_id

Delete AI content by batchId

**Parameters:**

| Parameter | Type   | Required | Default | Description       |
| --------- | ------ | -------- | ------- | ----------------- |
| `batchId` | string | Yes      | —       | Batch Id          |
| `project` | string | Yes      | —       | The project value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "batchId": {
        "type": "string",
        "description": "Batch Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      }
    },
    "required": [
      "PCID",
      "batchId",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_remove\_by\_content\_id

Delete AI content by contentId

**Parameters:**

| Parameter   | Type   | Required | Default | Description       |
| ----------- | ------ | -------- | ------- | ----------------- |
| `contentId` | string | Yes      | —       | Content Id        |
| `project`   | string | Yes      | —       | The project value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "contentId": {
        "type": "string",
        "description": "Content Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      }
    },
    "required": [
      "PCID",
      "contentId",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_remove\_old\_batches

Delete old AI content batches

**Parameters:**

| Parameter        | Type   | Required | Default | Description       |
| ---------------- | ------ | -------- | ------- | ----------------- |
| `project`        | string | Yes      | —       | The project value |
| `currentBatchId` | string | Yes      | —       | Current Batch Id  |
| `type`           | string | No       | —       | The type value    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "currentBatchId": {
        "type": "string",
        "description": "Current Batch Id"
      },
      "type": {
        "type": "string",
        "description": "The type value"
      }
    },
    "required": [
      "PCID",
      "project",
      "currentBatchId"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_search\_messages

Search messages

**Parameters:**

| Parameter    | Type   | Required | Default | Description                   |
| ------------ | ------ | -------- | ------- | ----------------------------- |
| `project`    | string | Yes      | —       | The project value             |
| `searchTerm` | string | Yes      | —       | Search term to filter results |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "searchTerm": {
        "type": "string",
        "description": "Search term to filter results"
      }
    },
    "required": [
      "PCID",
      "project",
      "searchTerm"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_suggest\_faq

FAQ suggestion

**Parameters:**

| Parameter   | Type    | Required | Default | Description       |
| ----------- | ------- | -------- | ------- | ----------------- |
| `messageId` | string  | Yes      | —       | Message Id        |
| `project`   | string  | Yes      | —       | The project value |
| `accept`    | boolean | Yes      | —       | The accept value  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messageId": {
        "type": "string",
        "description": "Message Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "accept": {
        "type": "boolean",
        "description": "The accept value"
      }
    },
    "required": [
      "PCID",
      "messageId",
      "project",
      "accept"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_update\_by\_content\_id

Update AI content by contentId

**Parameters:**

| Parameter       | Type   | Required | Default | Description       |
| --------------- | ------ | -------- | ------- | ----------------- |
| `contentId`     | string | Yes      | —       | Content Id        |
| `project`       | string | Yes      | —       | The project value |
| `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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "contentId": {
        "type": "string",
        "description": "Content Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "batchId": {
        "type": "string",
        "description": "Batch Id"
      },
      "content": {
        "description": "The content value"
      },
      "readMoreLabel": {
        "type": "string",
        "description": "Read More Label"
      },
      "readMoreUrl": {
        "type": "string",
        "description": "Read More Url"
      },
      "title": {
        "type": "string",
        "description": "The title value"
      },
      "type": {
        "type": "string",
        "description": "The type value"
      }
    },
    "required": [
      "PCID",
      "contentId",
      "project",
      "content",
      "title",
      "type"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_update\_message

Update a message

**Parameters:**

| Parameter                    | Type      | Required | Default | Description                  |
| ---------------------------- | --------- | -------- | ------- | ---------------------------- |
| `messageId`                  | string    | Yes      | —       | Message Id                   |
| `project`                    | string    | Yes      | —       | The project value            |
| `actions`                    | object\[] | No       | —       | The actions value            |
| `aiData`                     | object    | No       | —       | Ai Data                      |
| `attachments`                | object\[] | 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               |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messageId": {
        "type": "string",
        "description": "Message Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "actions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "data": {
              "description": "The data value"
            },
            "type": {
              "type": "string",
              "description": "The type value"
            }
          },
          "required": [
            "type"
          ]
        },
        "description": "The actions value"
      },
      "aiData": {
        "description": "Ai Data"
      },
      "attachments": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "The name value"
            },
            "url": {
              "type": "string",
              "description": "The url value"
            },
            "type": {
              "type": "string",
              "description": "The type value"
            }
          },
          "required": [
            "name",
            "url"
          ]
        },
        "description": "The attachments value"
      },
      "bot": {
        "type": "boolean",
        "description": "The bot value"
      },
      "channel": {
        "type": "object",
        "description": "The channel value",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id value"
          },
          "type": {
            "type": "string",
            "description": "The type value"
          },
          "messageId": {
            "type": "string",
            "description": "Message Id"
          }
        },
        "required": [
          "id"
        ]
      },
      "comment": {
        "description": "The comment value"
      },
      "data": {
        "description": "The data value"
      },
      "emailId": {
        "type": "string",
        "description": "Email Id"
      },
      "fallbackUser": {
        "type": "object",
        "description": "Fallback User",
        "properties": {
          "username": {
            "type": "string",
            "description": "The username value"
          },
          "email": {
            "type": "string",
            "description": "The email value"
          },
          "imageUrl": {
            "type": "string",
            "description": "Image Url"
          }
        }
      },
      "isNote": {
        "type": "boolean",
        "description": "Is Note"
      },
      "kaiChat": {
        "type": "boolean",
        "description": "Kai Chat"
      },
      "messageRef": {
        "type": "string",
        "description": "Message Ref"
      },
      "outbound": {
        "type": "string",
        "description": "The outbound value"
      },
      "outboundSubject": {
        "type": "string",
        "description": "Outbound Subject"
      },
      "outboundTemplate": {
        "type": "string",
        "description": "Outbound Template"
      },
      "rating": {
        "type": "string",
        "description": "The rating value"
      },
      "replyTo": {
        "type": "string",
        "description": "Reply To"
      },
      "sendToChannel": {
        "type": "boolean",
        "description": "Send To Channel"
      },
      "session": {
        "type": "string",
        "description": "The session value"
      },
      "sessionNotificationsUnread": {
        "type": "boolean",
        "description": "Session Notifications Unread"
      },
      "status": {
        "description": "The status value"
      },
      "statusHistory": {
        "type": "array",
        "description": "Status History"
      },
      "ticket": {
        "type": "string",
        "description": "The ticket value"
      },
      "translatedData": {
        "description": "Translated Data"
      },
      "type": {
        "type": "string",
        "description": "The type value"
      },
      "user": {
        "type": "string",
        "description": "The user value"
      }
    },
    "required": [
      "PCID",
      "messageId",
      "project"
    ]
  }
  ```
</Expandable>

***

## gleap\_messaging\_analytics\_update\_message\_template

Update a message template.

**Parameters:**

| Parameter           | Type      | Required | Default | Description           |
| ------------------- | --------- | -------- | ------- | --------------------- |
| `messageTemplateId` | string    | Yes      | —       | Message Template Id   |
| `project`           | string    | Yes      | —       | The project value     |
| `actions`           | object\[] | 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`             | string\[] | No       | —       | The users value       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messageTemplateId": {
        "type": "string",
        "description": "Message Template Id"
      },
      "project": {
        "type": "string",
        "description": "The project value"
      },
      "actions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "data": {
              "description": "The data value"
            },
            "type": {
              "type": "string",
              "description": "The type value"
            }
          },
          "required": [
            "type"
          ]
        },
        "description": "The actions value"
      },
      "attachments": {
        "type": "array",
        "description": "The attachments value"
      },
      "content": {
        "description": "The content value"
      },
      "isPublic": {
        "type": "boolean",
        "description": "Is Public"
      },
      "lexorank": {
        "type": "string",
        "description": "The lexorank value"
      },
      "title": {
        "type": "string",
        "description": "The title value"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The users value"
      }
    },
    "required": [
      "PCID",
      "messageTemplateId",
      "project",
      "content",
      "lexorank",
      "title"
    ]
  }
  ```
</Expandable>
