Skip to content

Commit a6833b9

Browse files
author
Muhammad Murtaza
committed
Add docs related to reporting data export
1 parent f6aa883 commit a6833b9

File tree

1 file changed

+280
-2
lines changed

1 file changed

+280
-2
lines changed

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 280 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1492,6 +1492,284 @@ paths:
14921492
$ref: "#/components/schemas/away_status_reason"
14931493
'401':
14941494
"$ref": "#/components/responses/Unauthorized"
1495+
"/export/reporting_data/enqueue":
1496+
post:
1497+
summary: Enqueue a new reporting data export job
1498+
parameters:
1499+
- name: Intercom-Version
1500+
in: header
1501+
schema:
1502+
"$ref": "#/components/schemas/intercom_version"
1503+
requestBody:
1504+
required: true
1505+
content:
1506+
application/json:
1507+
schema:
1508+
type: object
1509+
required: [dataset_id, attribute_ids, start_time, end_time]
1510+
properties:
1511+
dataset_id:
1512+
type: string
1513+
example: conversation
1514+
attribute_ids:
1515+
type: array
1516+
items:
1517+
type: string
1518+
example: [conversation.id, conversation.first_user_conversation_part_created_at]
1519+
start_time:
1520+
type: integer
1521+
format: int64
1522+
example: 1717490000
1523+
end_time:
1524+
type: integer
1525+
format: int64
1526+
example: 1717510000
1527+
responses:
1528+
'200':
1529+
description: Job enqueued successfully
1530+
content:
1531+
application/json:
1532+
schema:
1533+
type: object
1534+
properties:
1535+
job_identifier:
1536+
type: string
1537+
example: job1
1538+
status:
1539+
type: string
1540+
example: pending
1541+
download_url:
1542+
type: string
1543+
download_expires_at:
1544+
type: string
1545+
'400':
1546+
description: Bad request (e.g. validation errors)
1547+
content:
1548+
application/json:
1549+
examples:
1550+
No dataset_id:
1551+
value:
1552+
type: error.list
1553+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1554+
errors:
1555+
- code: bad_request
1556+
message: "'dataset_id' is a required parameter"
1557+
Invalid dataset_id:
1558+
value:
1559+
type: error.list
1560+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1561+
errors:
1562+
- code: bad_request
1563+
message: imaginary is not a valid dataset_id
1564+
No attribute_ids:
1565+
value:
1566+
type: error.list
1567+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1568+
errors:
1569+
- code: bad_request
1570+
message: "'attribute_ids' is a required parameter"
1571+
Empty attribute_ids:
1572+
value:
1573+
type: error.list
1574+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1575+
errors:
1576+
- code: bad_request
1577+
message: attribute_ids must contain at least one attribute_id
1578+
Non array attribute_ids:
1579+
value:
1580+
type: error.list
1581+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1582+
errors:
1583+
- code: bad_request
1584+
message: "'attribute_ids' not an array must be of type Array"
1585+
Invalid attribute_ids:
1586+
value:
1587+
type: error.list
1588+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1589+
errors:
1590+
- code: bad_request
1591+
message: "attribute_ids invalid for conversation dataset: non_existent"
1592+
schema:
1593+
"$ref": "#/components/schemas/error"
1594+
'401':
1595+
description: Unauthorized
1596+
content:
1597+
application/json:
1598+
examples:
1599+
Unauthorized:
1600+
value:
1601+
type: error.list
1602+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1603+
errors:
1604+
- code: unauthorized
1605+
message: Access Token Invalid
1606+
schema:
1607+
"$ref": "#/components/schemas/error"
1608+
'429':
1609+
description: Too many jobs in progress
1610+
content:
1611+
application/json:
1612+
examples:
1613+
Unauthorized:
1614+
value:
1615+
type: error.list
1616+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1617+
errors:
1618+
- code: rate_limit_exceeded
1619+
message: Exceeded rate limit of 5 pending reporting dataset export jobs
1620+
schema:
1621+
"$ref": "#/components/schemas/error"
1622+
"/export/reporting_data/{job_identifier}":
1623+
get:
1624+
summary: Get export job status
1625+
parameters:
1626+
- name: Intercom-Version
1627+
in: header
1628+
schema:
1629+
"$ref": "#/components/schemas/intercom_version"
1630+
- name: app_id
1631+
in: query
1632+
description: The Intercom defined code of the workspace the company is associated
1633+
to.
1634+
required: true
1635+
schema:
1636+
type: string
1637+
- name: client_id
1638+
in: query
1639+
required: true
1640+
schema:
1641+
type: string
1642+
- name: job_identifier
1643+
description: Unique identifier of the job.
1644+
in: query
1645+
required: true
1646+
schema:
1647+
type: string
1648+
responses:
1649+
'200':
1650+
description: Job status returned successfully
1651+
content:
1652+
application/json:
1653+
examples:
1654+
With complete status:
1655+
value:
1656+
job_identifier: job1
1657+
status: complete
1658+
download_url: ''
1659+
download_expires_at: ''
1660+
With failed status:
1661+
value:
1662+
job_identifier: job1
1663+
status: failed
1664+
download_url: ''
1665+
download_expires_at: ''
1666+
schema:
1667+
type: object
1668+
properties:
1669+
job_identifier:
1670+
type: string
1671+
status:
1672+
type: string
1673+
download_url:
1674+
type: string
1675+
download_expires_at:
1676+
type: string
1677+
'404':
1678+
description: When job not found
1679+
content:
1680+
application/json:
1681+
examples:
1682+
Not found:
1683+
value:
1684+
type: error.list
1685+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1686+
errors:
1687+
- code: not_found
1688+
message: "Export job not found for identifier: job1"
1689+
schema:
1690+
"$ref": "#/components/schemas/error"
1691+
"/export/reporting_data/get_datasets":
1692+
get:
1693+
summary: List available datasets and attributes
1694+
parameters:
1695+
- name: Intercom-Version
1696+
in: header
1697+
schema:
1698+
"$ref": "#/components/schemas/intercom_version"
1699+
responses:
1700+
'200':
1701+
description: List of datasets
1702+
content:
1703+
application/json:
1704+
schema:
1705+
type: object
1706+
properties:
1707+
type:
1708+
type: string
1709+
example: list
1710+
data:
1711+
type: array
1712+
items:
1713+
type: object
1714+
properties:
1715+
id:
1716+
type: string
1717+
example: conversation
1718+
name:
1719+
type: string
1720+
example: Conversation
1721+
description:
1722+
type: string
1723+
example: "Conversation-level details: status, channel, assignee."
1724+
default_time_attribute_id:
1725+
type: string
1726+
example: conversation.first_user_conversation_part_created_at
1727+
attributes:
1728+
type: array
1729+
items:
1730+
type: object
1731+
properties:
1732+
id:
1733+
type: string
1734+
example: conversation.id
1735+
name:
1736+
type: string
1737+
example: Conversation ID
1738+
"/download/reporting_data/{job_identifier}":
1739+
get:
1740+
summary: Download completed export job data
1741+
parameters:
1742+
- name: Intercom-Version
1743+
in: header
1744+
schema:
1745+
"$ref": "#/components/schemas/intercom_version"
1746+
- name: app_id
1747+
in: query
1748+
required: true
1749+
schema:
1750+
type: string
1751+
- name: job_identifier
1752+
in: query
1753+
required: true
1754+
schema:
1755+
type: string
1756+
responses:
1757+
'200':
1758+
description: Export file downloaded
1759+
'404':
1760+
description: When job not found
1761+
content:
1762+
application/json:
1763+
examples:
1764+
Not found:
1765+
value:
1766+
type: error.list
1767+
request_id: b68959ea-6328-4f70-83cb-e7913dba1542
1768+
errors:
1769+
- code: not_found
1770+
message: "Export job not found for identifier: job1"
1771+
schema:
1772+
"$ref": "#/components/schemas/error"
14951773
"/help_center/collections":
14961774
get:
14971775
summary: List all collections
@@ -9194,8 +9472,8 @@ paths:
91949472
operationId: getWhatsAppMessageStatus
91959473
description: |
91969474
Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.
9197-
9198-
9475+
9476+
91999477
This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing
92009478
information about delivery state and related message details.
92019479
responses:

0 commit comments

Comments
 (0)