Skip to content

Commit 3b5263e

Browse files
steve-henryclaude
andauthored
Add date-range caveat to first_open and first_series_disengagement field descriptions (#563)
* Add date-range caveat to first_open and first_series_disengagement fields Append "Only events within the export job's requested date range are counted." to the description of these two export stats fields across all spec versions. - intercom/developer-docs#991 * Extend date-range caveat to all first_* export receipt fields Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 25c8386 commit 3b5263e

10 files changed

Lines changed: 120 additions & 110 deletions

descriptions/0/api.intercom.io.yaml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32361,43 +32361,44 @@ components:
3236132361
first_reply:
3236232362
type: integer
3236332363
description: The first time a user replied to this message if the content
32364-
was able to receive replies.
32364+
was able to receive replies. Only events within the export job's requested date range are counted.
3236532365
first_completion:
3236632366
type: integer
3236732367
description: The first time a user completed this message if the content
32368-
was able to be completed e.g. Tours, Surveys.
32368+
was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted.
3236932369
first_series_completion:
3237032370
type: integer
3237132371
description: The first time the series this message was a part of was completed
32372-
by the user.
32372+
by the user. Only events within the export job's requested date range are counted.
3237332373
first_series_disengagement:
3237432374
type: integer
3237532375
description: The first time the series this message was a part of was disengaged
32376-
by the user.
32376+
by the user. Only events within the export job's requested date range are counted.
3237732377
first_series_exit:
3237832378
type: integer
3237932379
description: The first time the series this message was a part of was exited
32380-
by the user.
32380+
by the user. Only events within the export job's requested date range are counted.
3238132381
first_goal_success:
3238232382
type: integer
3238332383
description: The first time the user met this messages associated goal if
32384-
one exists.
32384+
one exists. Only events within the export job's requested date range are counted.
3238532385
first_open:
3238632386
type: integer
32387-
description: The first time the user opened this message.
32387+
description: The first time the user opened this message. Only events within
32388+
the export job's requested date range are counted.
3238832389
first_click:
3238932390
type: integer
3239032391
description: The first time the series the user clicked on a link within
32391-
this message.
32392+
this message. Only events within the export job's requested date range are counted.
3239232393
first_dismisall:
3239332394
type: integer
32394-
description: The first time the series the user dismissed this message.
32395+
description: The first time the series the user dismissed this message. Only events within the export job's requested date range are counted.
3239532396
first_unsubscribe:
3239632397
type: integer
32397-
description: The first time the user unsubscribed from this message.
32398+
description: The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted.
3239832399
first_hard_bounce:
3239932400
type: integer
32400-
description: The first time this message hard bounced for this user
32401+
description: The first time this message hard bounced for this user. Only events within the export job's requested date range are counted.
3240132402
deleted_article_object:
3240232403
title: Deleted Article Object
3240332404
type: object

descriptions/2.10/api.intercom.io.yaml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14719,43 +14719,44 @@ components:
1471914719
first_reply:
1472014720
type: integer
1472114721
description: The first time a user replied to this message if the content
14722-
was able to receive replies.
14722+
was able to receive replies. Only events within the export job's requested date range are counted.
1472314723
first_completion:
1472414724
type: integer
1472514725
description: The first time a user completed this message if the content
14726-
was able to be completed e.g. Tours, Surveys.
14726+
was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted.
1472714727
first_series_completion:
1472814728
type: integer
1472914729
description: The first time the series this message was a part of was completed
14730-
by the user.
14730+
by the user. Only events within the export job's requested date range are counted.
1473114731
first_series_disengagement:
1473214732
type: integer
1473314733
description: The first time the series this message was a part of was disengaged
14734-
by the user.
14734+
by the user. Only events within the export job's requested date range are counted.
1473514735
first_series_exit:
1473614736
type: integer
1473714737
description: The first time the series this message was a part of was exited
14738-
by the user.
14738+
by the user. Only events within the export job's requested date range are counted.
1473914739
first_goal_success:
1474014740
type: integer
1474114741
description: The first time the user met this messages associated goal if
14742-
one exists.
14742+
one exists. Only events within the export job's requested date range are counted.
1474314743
first_open:
1474414744
type: integer
14745-
description: The first time the user opened this message.
14745+
description: The first time the user opened this message. Only events within
14746+
the export job's requested date range are counted.
1474614747
first_click:
1474714748
type: integer
1474814749
description: The first time the series the user clicked on a link within
14749-
this message.
14750+
this message. Only events within the export job's requested date range are counted.
1475014751
first_dismisall:
1475114752
type: integer
14752-
description: The first time the series the user dismissed this message.
14753+
description: The first time the series the user dismissed this message. Only events within the export job's requested date range are counted.
1475314754
first_unsubscribe:
1475414755
type: integer
14755-
description: The first time the user unsubscribed from this message.
14756+
description: The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted.
1475614757
first_hard_bounce:
1475714758
type: integer
14758-
description: The first time this message hard bounced for this user
14759+
description: The first time this message hard bounced for this user. Only events within the export job's requested date range are counted.
1475914760
deleted_article_object:
1476014761
title: Deleted Article Object
1476114762
type: object

descriptions/2.11/api.intercom.io.yaml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15582,43 +15582,44 @@ components:
1558215582
first_reply:
1558315583
type: integer
1558415584
description: The first time a user replied to this message if the content
15585-
was able to receive replies.
15585+
was able to receive replies. Only events within the export job's requested date range are counted.
1558615586
first_completion:
1558715587
type: integer
1558815588
description: The first time a user completed this message if the content
15589-
was able to be completed e.g. Tours, Surveys.
15589+
was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted.
1559015590
first_series_completion:
1559115591
type: integer
1559215592
description: The first time the series this message was a part of was completed
15593-
by the user.
15593+
by the user. Only events within the export job's requested date range are counted.
1559415594
first_series_disengagement:
1559515595
type: integer
1559615596
description: The first time the series this message was a part of was disengaged
15597-
by the user.
15597+
by the user. Only events within the export job's requested date range are counted.
1559815598
first_series_exit:
1559915599
type: integer
1560015600
description: The first time the series this message was a part of was exited
15601-
by the user.
15601+
by the user. Only events within the export job's requested date range are counted.
1560215602
first_goal_success:
1560315603
type: integer
1560415604
description: The first time the user met this messages associated goal if
15605-
one exists.
15605+
one exists. Only events within the export job's requested date range are counted.
1560615606
first_open:
1560715607
type: integer
15608-
description: The first time the user opened this message.
15608+
description: The first time the user opened this message. Only events within
15609+
the export job's requested date range are counted.
1560915610
first_click:
1561015611
type: integer
1561115612
description: The first time the series the user clicked on a link within
15612-
this message.
15613+
this message. Only events within the export job's requested date range are counted.
1561315614
first_dismisall:
1561415615
type: integer
15615-
description: The first time the series the user dismissed this message.
15616+
description: The first time the series the user dismissed this message. Only events within the export job's requested date range are counted.
1561615617
first_unsubscribe:
1561715618
type: integer
15618-
description: The first time the user unsubscribed from this message.
15619+
description: The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted.
1561915620
first_hard_bounce:
1562015621
type: integer
15621-
description: The first time this message hard bounced for this user
15622+
description: The first time this message hard bounced for this user. Only events within the export job's requested date range are counted.
1562215623
required:
1562315624
- user_id
1562415625
- company_id

descriptions/2.12/api.intercom.io.yaml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15994,43 +15994,44 @@ components:
1599415994
first_reply:
1599515995
type: integer
1599615996
description: The first time a user replied to this message if the content
15997-
was able to receive replies.
15997+
was able to receive replies. Only events within the export job's requested date range are counted.
1599815998
first_completion:
1599915999
type: integer
1600016000
description: The first time a user completed this message if the content
16001-
was able to be completed e.g. Tours, Surveys.
16001+
was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted.
1600216002
first_series_completion:
1600316003
type: integer
1600416004
description: The first time the series this message was a part of was completed
16005-
by the user.
16005+
by the user. Only events within the export job's requested date range are counted.
1600616006
first_series_disengagement:
1600716007
type: integer
1600816008
description: The first time the series this message was a part of was disengaged
16009-
by the user.
16009+
by the user. Only events within the export job's requested date range are counted.
1601016010
first_series_exit:
1601116011
type: integer
1601216012
description: The first time the series this message was a part of was exited
16013-
by the user.
16013+
by the user. Only events within the export job's requested date range are counted.
1601416014
first_goal_success:
1601516015
type: integer
1601616016
description: The first time the user met this messages associated goal if
16017-
one exists.
16017+
one exists. Only events within the export job's requested date range are counted.
1601816018
first_open:
1601916019
type: integer
16020-
description: The first time the user opened this message.
16020+
description: The first time the user opened this message. Only events within
16021+
the export job's requested date range are counted.
1602116022
first_click:
1602216023
type: integer
1602316024
description: The first time the series the user clicked on a link within
16024-
this message.
16025+
this message. Only events within the export job's requested date range are counted.
1602516026
first_dismisall:
1602616027
type: integer
16027-
description: The first time the series the user dismissed this message.
16028+
description: The first time the series the user dismissed this message. Only events within the export job's requested date range are counted.
1602816029
first_unsubscribe:
1602916030
type: integer
16030-
description: The first time the user unsubscribed from this message.
16031+
description: The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted.
1603116032
first_hard_bounce:
1603216033
type: integer
16033-
description: The first time this message hard bounced for this user
16034+
description: The first time this message hard bounced for this user. Only events within the export job's requested date range are counted.
1603416035
deleted_article_object:
1603516036
title: Deleted Article Object
1603616037
type: object

descriptions/2.13/api.intercom.io.yaml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17460,43 +17460,44 @@ components:
1746017460
first_reply:
1746117461
type: integer
1746217462
description: The first time a user replied to this message if the content
17463-
was able to receive replies.
17463+
was able to receive replies. Only events within the export job's requested date range are counted.
1746417464
first_completion:
1746517465
type: integer
1746617466
description: The first time a user completed this message if the content
17467-
was able to be completed e.g. Tours, Surveys.
17467+
was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted.
1746817468
first_series_completion:
1746917469
type: integer
1747017470
description: The first time the series this message was a part of was completed
17471-
by the user.
17471+
by the user. Only events within the export job's requested date range are counted.
1747217472
first_series_disengagement:
1747317473
type: integer
1747417474
description: The first time the series this message was a part of was disengaged
17475-
by the user.
17475+
by the user. Only events within the export job's requested date range are counted.
1747617476
first_series_exit:
1747717477
type: integer
1747817478
description: The first time the series this message was a part of was exited
17479-
by the user.
17479+
by the user. Only events within the export job's requested date range are counted.
1748017480
first_goal_success:
1748117481
type: integer
1748217482
description: The first time the user met this messages associated goal if
17483-
one exists.
17483+
one exists. Only events within the export job's requested date range are counted.
1748417484
first_open:
1748517485
type: integer
17486-
description: The first time the user opened this message.
17486+
description: The first time the user opened this message. Only events within
17487+
the export job's requested date range are counted.
1748717488
first_click:
1748817489
type: integer
1748917490
description: The first time the series the user clicked on a link within
17490-
this message.
17491+
this message. Only events within the export job's requested date range are counted.
1749117492
first_dismisall:
1749217493
type: integer
17493-
description: The first time the series the user dismissed this message.
17494+
description: The first time the series the user dismissed this message. Only events within the export job's requested date range are counted.
1749417495
first_unsubscribe:
1749517496
type: integer
17496-
description: The first time the user unsubscribed from this message.
17497+
description: The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted.
1749717498
first_hard_bounce:
1749817499
type: integer
17499-
description: The first time this message hard bounced for this user
17500+
description: The first time this message hard bounced for this user. Only events within the export job's requested date range are counted.
1750017501
deleted_article_object:
1750117502
title: Deleted Article Object
1750217503
type: object

descriptions/2.14/api.intercom.io.yaml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19306,43 +19306,44 @@ components:
1930619306
first_reply:
1930719307
type: integer
1930819308
description: The first time a user replied to this message if the content
19309-
was able to receive replies.
19309+
was able to receive replies. Only events within the export job's requested date range are counted.
1931019310
first_completion:
1931119311
type: integer
1931219312
description: The first time a user completed this message if the content
19313-
was able to be completed e.g. Tours, Surveys.
19313+
was able to be completed e.g. Tours, Surveys. Only events within the export job's requested date range are counted.
1931419314
first_series_completion:
1931519315
type: integer
1931619316
description: The first time the series this message was a part of was completed
19317-
by the user.
19317+
by the user. Only events within the export job's requested date range are counted.
1931819318
first_series_disengagement:
1931919319
type: integer
1932019320
description: The first time the series this message was a part of was disengaged
19321-
by the user.
19321+
by the user. Only events within the export job's requested date range are counted.
1932219322
first_series_exit:
1932319323
type: integer
1932419324
description: The first time the series this message was a part of was exited
19325-
by the user.
19325+
by the user. Only events within the export job's requested date range are counted.
1932619326
first_goal_success:
1932719327
type: integer
1932819328
description: The first time the user met this messages associated goal if
19329-
one exists.
19329+
one exists. Only events within the export job's requested date range are counted.
1933019330
first_open:
1933119331
type: integer
19332-
description: The first time the user opened this message.
19332+
description: The first time the user opened this message. Only events within
19333+
the export job's requested date range are counted.
1933319334
first_click:
1933419335
type: integer
1933519336
description: The first time the series the user clicked on a link within
19336-
this message.
19337+
this message. Only events within the export job's requested date range are counted.
1933719338
first_dismisall:
1933819339
type: integer
19339-
description: The first time the series the user dismissed this message.
19340+
description: The first time the series the user dismissed this message. Only events within the export job's requested date range are counted.
1934019341
first_unsubscribe:
1934119342
type: integer
19342-
description: The first time the user unsubscribed from this message.
19343+
description: The first time the user unsubscribed from this message. Only events within the export job's requested date range are counted.
1934319344
first_hard_bounce:
1934419345
type: integer
19345-
description: The first time this message hard bounced for this user
19346+
description: The first time this message hard bounced for this user. Only events within the export job's requested date range are counted.
1934619347
deleted_article_object:
1934719348
title: Deleted Article Object
1934819349
type: object

0 commit comments

Comments
 (0)