From 1a7c9690c8c2ba12e9ec8db9c866e89478b4c818 Mon Sep 17 00:00:00 2001 From: Daniel Qian Date: Mon, 20 Apr 2026 15:26:14 +0100 Subject: [PATCH] docs: clarify Data Export API descriptions across all spec versions The previous descriptions were vague ("view all messages sent & viewed"). Updated to specify that the endpoint exports message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content. Co-Authored-By: Claude Opus 4.6 --- descriptions/0/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.10/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.11/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.12/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.13/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.14/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.15/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.7/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.8/api.intercom.io.yaml | 16 ++++++++++++---- descriptions/2.9/api.intercom.io.yaml | 16 ++++++++++++---- 10 files changed, 120 insertions(+), 40 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 881cdb1..39ff2d2 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -12153,7 +12153,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -24333,8 +24338,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identfier: type: string @@ -29243,7 +29251,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Emails description: Everything about your Emails - name: Fin Agent diff --git a/descriptions/2.10/api.intercom.io.yaml b/descriptions/2.10/api.intercom.io.yaml index fd32d56..9535d3c 100644 --- a/descriptions/2.10/api.intercom.io.yaml +++ b/descriptions/2.10/api.intercom.io.yaml @@ -7207,7 +7207,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -14607,8 +14612,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identfier: type: string @@ -17383,7 +17391,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Help Center description: Everything about your Help Center - name: Messages diff --git a/descriptions/2.11/api.intercom.io.yaml b/descriptions/2.11/api.intercom.io.yaml index e9fd9a3..0eec29d 100644 --- a/descriptions/2.11/api.intercom.io.yaml +++ b/descriptions/2.11/api.intercom.io.yaml @@ -7299,7 +7299,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -15465,8 +15470,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identifier: type: string @@ -19271,7 +19279,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Help Center description: Everything about your Help Center - name: Messages diff --git a/descriptions/2.12/api.intercom.io.yaml b/descriptions/2.12/api.intercom.io.yaml index 70d32ee..752064f 100644 --- a/descriptions/2.12/api.intercom.io.yaml +++ b/descriptions/2.12/api.intercom.io.yaml @@ -7697,7 +7697,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -15875,8 +15880,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identfier: type: string @@ -18983,7 +18991,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Help Center description: Everything about your Help Center - name: Messages diff --git a/descriptions/2.13/api.intercom.io.yaml b/descriptions/2.13/api.intercom.io.yaml index 2ab5d11..6d490dd 100644 --- a/descriptions/2.13/api.intercom.io.yaml +++ b/descriptions/2.13/api.intercom.io.yaml @@ -8927,7 +8927,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -17341,8 +17346,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identfier: type: string @@ -20768,7 +20776,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Help Center description: Everything about your Help Center - name: Messages diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 1971528..65de333 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -9758,7 +9758,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -19186,8 +19191,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identifier: type: string @@ -23210,7 +23218,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Fin Agent description: | Access Fin programmatically via the Fin Agent API endpoints. diff --git a/descriptions/2.15/api.intercom.io.yaml b/descriptions/2.15/api.intercom.io.yaml index fd8aabe..0544c11 100644 --- a/descriptions/2.15/api.intercom.io.yaml +++ b/descriptions/2.15/api.intercom.io.yaml @@ -9829,7 +9829,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -19913,8 +19918,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identifier: type: string @@ -24158,7 +24166,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Emails description: Everything about your Email Settings - name: Fin Agent diff --git a/descriptions/2.7/api.intercom.io.yaml b/descriptions/2.7/api.intercom.io.yaml index 4b5c791..69e16ec 100644 --- a/descriptions/2.7/api.intercom.io.yaml +++ b/descriptions/2.7/api.intercom.io.yaml @@ -7192,7 +7192,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -12544,8 +12549,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identfier: type: string @@ -14713,7 +14721,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Help Center description: Everything about your Help Center - name: Messages diff --git a/descriptions/2.8/api.intercom.io.yaml b/descriptions/2.8/api.intercom.io.yaml index a516cac..1fd48dc 100644 --- a/descriptions/2.8/api.intercom.io.yaml +++ b/descriptions/2.8/api.intercom.io.yaml @@ -7192,7 +7192,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -12568,8 +12573,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identfier: type: string @@ -14760,7 +14768,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Help Center description: Everything about your Help Center - name: Messages diff --git a/descriptions/2.9/api.intercom.io.yaml b/descriptions/2.9/api.intercom.io.yaml index 4cb3be2..ae1900d 100644 --- a/descriptions/2.9/api.intercom.io.yaml +++ b/descriptions/2.9/api.intercom.io.yaml @@ -7205,7 +7205,12 @@ paths: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to - the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis + endpoint exports **message delivery and engagement data** for outbound content + (Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported + data includes who received each message, when they received it, and how they + engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes, + and bounces). It does not export raw message or conversation content.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate @@ -13919,8 +13924,11 @@ components: type: object x-tags: - Data Export - description: The data export api is used to view all message sent & viewed in - a given timeframe. + description: The data export API is used to export message delivery and engagement + statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours, + Series, and more) sent in a given timeframe. The exported data includes who + received each message, when they received it, and how they engaged with it + (opens, clicks, replies, completions, dismissals, unsubscribes, and bounces). properties: job_identfier: type: string @@ -16697,7 +16705,7 @@ tags: - name: Data Events description: Everything about your Data Events - name: Data Export - description: Everything about your Data Exports + description: Export message delivery and engagement statistics (opens, clicks, replies, completions, dismissals, unsubscribes, bounces) for outbound content such as Emails, Posts, Custom Bots, Surveys, Tours, and Series. - name: Help Center description: Everything about your Help Center - name: Messages