Skip to content

Commit 836fc59

Browse files
dan0505claude
andauthored
docs: clarify Data Export API descriptions across all spec versions (#467)
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 <noreply@anthropic.com>
1 parent 43bfa05 commit 836fc59

10 files changed

Lines changed: 120 additions & 40 deletions

descriptions/0/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12153,7 +12153,12 @@ paths:
1215312153
- Data Export
1215412154
operationId: createDataExport
1215512155
description: "To create your export job, you need to send a `POST` request to
12156-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
12156+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
12157+
endpoint exports **message delivery and engagement data** for outbound content
12158+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
12159+
data includes who received each message, when they received it, and how they
12160+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
12161+
and bounces). It does not export raw message or conversation content.\n\nThe
1215712162
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
1215812163
Limit of one active job\n>\n> You can only have one active job per workspace.
1215912164
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -24333,8 +24338,11 @@ components:
2433324338
type: object
2433424339
x-tags:
2433524340
- Data Export
24336-
description: The data export api is used to view all message sent & viewed in
24337-
a given timeframe.
24341+
description: The data export API is used to export message delivery and engagement
24342+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
24343+
Series, and more) sent in a given timeframe. The exported data includes who
24344+
received each message, when they received it, and how they engaged with it
24345+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
2433824346
properties:
2433924347
job_identfier:
2434024348
type: string
@@ -29243,7 +29251,7 @@ tags:
2924329251
- name: Data Events
2924429252
description: Everything about your Data Events
2924529253
- name: Data Export
29246-
description: Everything about your Data Exports
29254+
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.
2924729255
- name: Emails
2924829256
description: Everything about your Emails
2924929257
- name: Fin Agent

descriptions/2.10/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7207,7 +7207,12 @@ paths:
72077207
- Data Export
72087208
operationId: createDataExport
72097209
description: "To create your export job, you need to send a `POST` request to
7210-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
7210+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
7211+
endpoint exports **message delivery and engagement data** for outbound content
7212+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
7213+
data includes who received each message, when they received it, and how they
7214+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
7215+
and bounces). It does not export raw message or conversation content.\n\nThe
72117216
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
72127217
Limit of one active job\n>\n> You can only have one active job per workspace.
72137218
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -14607,8 +14612,11 @@ components:
1460714612
type: object
1460814613
x-tags:
1460914614
- Data Export
14610-
description: The data export api is used to view all message sent & viewed in
14611-
a given timeframe.
14615+
description: The data export API is used to export message delivery and engagement
14616+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
14617+
Series, and more) sent in a given timeframe. The exported data includes who
14618+
received each message, when they received it, and how they engaged with it
14619+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1461214620
properties:
1461314621
job_identfier:
1461414622
type: string
@@ -17383,7 +17391,7 @@ tags:
1738317391
- name: Data Events
1738417392
description: Everything about your Data Events
1738517393
- name: Data Export
17386-
description: Everything about your Data Exports
17394+
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.
1738717395
- name: Help Center
1738817396
description: Everything about your Help Center
1738917397
- name: Messages

descriptions/2.11/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7299,7 +7299,12 @@ paths:
72997299
- Data Export
73007300
operationId: createDataExport
73017301
description: "To create your export job, you need to send a `POST` request to
7302-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
7302+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
7303+
endpoint exports **message delivery and engagement data** for outbound content
7304+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
7305+
data includes who received each message, when they received it, and how they
7306+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
7307+
and bounces). It does not export raw message or conversation content.\n\nThe
73037308
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
73047309
Limit of one active job\n>\n> You can only have one active job per workspace.
73057310
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -15465,8 +15470,11 @@ components:
1546515470
type: object
1546615471
x-tags:
1546715472
- Data Export
15468-
description: The data export api is used to view all message sent & viewed in
15469-
a given timeframe.
15473+
description: The data export API is used to export message delivery and engagement
15474+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
15475+
Series, and more) sent in a given timeframe. The exported data includes who
15476+
received each message, when they received it, and how they engaged with it
15477+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1547015478
properties:
1547115479
job_identifier:
1547215480
type: string
@@ -19271,7 +19279,7 @@ tags:
1927119279
- name: Data Events
1927219280
description: Everything about your Data Events
1927319281
- name: Data Export
19274-
description: Everything about your Data Exports
19282+
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.
1927519283
- name: Help Center
1927619284
description: Everything about your Help Center
1927719285
- name: Messages

descriptions/2.12/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7697,7 +7697,12 @@ paths:
76977697
- Data Export
76987698
operationId: createDataExport
76997699
description: "To create your export job, you need to send a `POST` request to
7700-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
7700+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
7701+
endpoint exports **message delivery and engagement data** for outbound content
7702+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
7703+
data includes who received each message, when they received it, and how they
7704+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
7705+
and bounces). It does not export raw message or conversation content.\n\nThe
77017706
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
77027707
Limit of one active job\n>\n> You can only have one active job per workspace.
77037708
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -15875,8 +15880,11 @@ components:
1587515880
type: object
1587615881
x-tags:
1587715882
- Data Export
15878-
description: The data export api is used to view all message sent & viewed in
15879-
a given timeframe.
15883+
description: The data export API is used to export message delivery and engagement
15884+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
15885+
Series, and more) sent in a given timeframe. The exported data includes who
15886+
received each message, when they received it, and how they engaged with it
15887+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1588015888
properties:
1588115889
job_identfier:
1588215890
type: string
@@ -18983,7 +18991,7 @@ tags:
1898318991
- name: Data Events
1898418992
description: Everything about your Data Events
1898518993
- name: Data Export
18986-
description: Everything about your Data Exports
18994+
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.
1898718995
- name: Help Center
1898818996
description: Everything about your Help Center
1898918997
- name: Messages

descriptions/2.13/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8927,7 +8927,12 @@ paths:
89278927
- Data Export
89288928
operationId: createDataExport
89298929
description: "To create your export job, you need to send a `POST` request to
8930-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
8930+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
8931+
endpoint exports **message delivery and engagement data** for outbound content
8932+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
8933+
data includes who received each message, when they received it, and how they
8934+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
8935+
and bounces). It does not export raw message or conversation content.\n\nThe
89318936
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
89328937
Limit of one active job\n>\n> You can only have one active job per workspace.
89338938
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -17341,8 +17346,11 @@ components:
1734117346
type: object
1734217347
x-tags:
1734317348
- Data Export
17344-
description: The data export api is used to view all message sent & viewed in
17345-
a given timeframe.
17349+
description: The data export API is used to export message delivery and engagement
17350+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
17351+
Series, and more) sent in a given timeframe. The exported data includes who
17352+
received each message, when they received it, and how they engaged with it
17353+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1734617354
properties:
1734717355
job_identfier:
1734817356
type: string
@@ -20768,7 +20776,7 @@ tags:
2076820776
- name: Data Events
2076920777
description: Everything about your Data Events
2077020778
- name: Data Export
20771-
description: Everything about your Data Exports
20779+
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.
2077220780
- name: Help Center
2077320781
description: Everything about your Help Center
2077420782
- name: Messages

descriptions/2.14/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9758,7 +9758,12 @@ paths:
97589758
- Data Export
97599759
operationId: createDataExport
97609760
description: "To create your export job, you need to send a `POST` request to
9761-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
9761+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
9762+
endpoint exports **message delivery and engagement data** for outbound content
9763+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
9764+
data includes who received each message, when they received it, and how they
9765+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
9766+
and bounces). It does not export raw message or conversation content.\n\nThe
97629767
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
97639768
Limit of one active job\n>\n> You can only have one active job per workspace.
97649769
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -19186,8 +19191,11 @@ components:
1918619191
type: object
1918719192
x-tags:
1918819193
- Data Export
19189-
description: The data export api is used to view all message sent & viewed in
19190-
a given timeframe.
19194+
description: The data export API is used to export message delivery and engagement
19195+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
19196+
Series, and more) sent in a given timeframe. The exported data includes who
19197+
received each message, when they received it, and how they engaged with it
19198+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1919119199
properties:
1919219200
job_identifier:
1919319201
type: string
@@ -23210,7 +23218,7 @@ tags:
2321023218
- name: Data Events
2321123219
description: Everything about your Data Events
2321223220
- name: Data Export
23213-
description: Everything about your Data Exports
23221+
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.
2321423222
- name: Fin Agent
2321523223
description: |
2321623224
Access Fin programmatically via the Fin Agent API endpoints.

descriptions/2.15/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9829,7 +9829,12 @@ paths:
98299829
- Data Export
98309830
operationId: createDataExport
98319831
description: "To create your export job, you need to send a `POST` request to
9832-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
9832+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
9833+
endpoint exports **message delivery and engagement data** for outbound content
9834+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
9835+
data includes who received each message, when they received it, and how they
9836+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
9837+
and bounces). It does not export raw message or conversation content.\n\nThe
98339838
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
98349839
Limit of one active job\n>\n> You can only have one active job per workspace.
98359840
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -19913,8 +19918,11 @@ components:
1991319918
type: object
1991419919
x-tags:
1991519920
- Data Export
19916-
description: The data export api is used to view all message sent & viewed in
19917-
a given timeframe.
19921+
description: The data export API is used to export message delivery and engagement
19922+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
19923+
Series, and more) sent in a given timeframe. The exported data includes who
19924+
received each message, when they received it, and how they engaged with it
19925+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1991819926
properties:
1991919927
job_identifier:
1992019928
type: string
@@ -24158,7 +24166,7 @@ tags:
2415824166
- name: Data Events
2415924167
description: Everything about your Data Events
2416024168
- name: Data Export
24161-
description: Everything about your Data Exports
24169+
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.
2416224170
- name: Emails
2416324171
description: Everything about your Email Settings
2416424172
- name: Fin Agent

descriptions/2.7/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7192,7 +7192,12 @@ paths:
71927192
- Data Export
71937193
operationId: createDataExport
71947194
description: "To create your export job, you need to send a `POST` request to
7195-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
7195+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
7196+
endpoint exports **message delivery and engagement data** for outbound content
7197+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
7198+
data includes who received each message, when they received it, and how they
7199+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
7200+
and bounces). It does not export raw message or conversation content.\n\nThe
71967201
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
71977202
Limit of one active job\n>\n> You can only have one active job per workspace.
71987203
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -12544,8 +12549,11 @@ components:
1254412549
type: object
1254512550
x-tags:
1254612551
- Data Export
12547-
description: The data export api is used to view all message sent & viewed in
12548-
a given timeframe.
12552+
description: The data export API is used to export message delivery and engagement
12553+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
12554+
Series, and more) sent in a given timeframe. The exported data includes who
12555+
received each message, when they received it, and how they engaged with it
12556+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1254912557
properties:
1255012558
job_identfier:
1255112559
type: string
@@ -14713,7 +14721,7 @@ tags:
1471314721
- name: Data Events
1471414722
description: Everything about your Data Events
1471514723
- name: Data Export
14716-
description: Everything about your Data Exports
14724+
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.
1471714725
- name: Help Center
1471814726
description: Everything about your Help Center
1471914727
- name: Messages

descriptions/2.8/api.intercom.io.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7192,7 +7192,12 @@ paths:
71927192
- Data Export
71937193
operationId: createDataExport
71947194
description: "To create your export job, you need to send a `POST` request to
7195-
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe
7195+
the export endpoint `https://api.intercom.io/export/content/data`.\n\nThis
7196+
endpoint exports **message delivery and engagement data** for outbound content
7197+
(Emails, Posts, Custom Bots, Surveys, Tours, Series, and more). The exported
7198+
data includes who received each message, when they received it, and how they
7199+
engaged with it (opens, clicks, replies, completions, dismissals, unsubscribes,
7200+
and bounces). It does not export raw message or conversation content.\n\nThe
71967201
only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7
71977202
Limit of one active job\n>\n> You can only have one active job per workspace.
71987203
You will receive a HTTP status code of 429 with the message Exceeded rate
@@ -12568,8 +12573,11 @@ components:
1256812573
type: object
1256912574
x-tags:
1257012575
- Data Export
12571-
description: The data export api is used to view all message sent & viewed in
12572-
a given timeframe.
12576+
description: The data export API is used to export message delivery and engagement
12577+
statistics for outbound content (Emails, Posts, Custom Bots, Surveys, Tours,
12578+
Series, and more) sent in a given timeframe. The exported data includes who
12579+
received each message, when they received it, and how they engaged with it
12580+
(opens, clicks, replies, completions, dismissals, unsubscribes, and bounces).
1257312581
properties:
1257412582
job_identfier:
1257512583
type: string
@@ -14760,7 +14768,7 @@ tags:
1476014768
- name: Data Events
1476114769
description: Everything about your Data Events
1476214770
- name: Data Export
14763-
description: Everything about your Data Exports
14771+
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.
1476414772
- name: Help Center
1476514773
description: Everything about your Help Center
1476614774
- name: Messages

0 commit comments

Comments
 (0)