Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 71 additions & 5 deletions spec/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6217,6 +6217,21 @@ components:
example: "true"
message_format:
$ref: '#/components/schemas/format'
channels:
description: Filter the report by one or more message channels.
type: array
items:
type: string
enum:
- SMS
- MMS
- TTS
- RCS
- WHATSAPP
- CHANNEL
example:
- SMS
- WHATSAPP
page:
description: Page number for paging through paginated result sets.
type: number
Expand Down Expand Up @@ -6387,16 +6402,16 @@ components:
type: object
properties:
start_date:
description: Start date time for report window. By default, the timezone for this parameter will be taken from the account settings for the account associated with the credentials used to make the request, or the account included in the Account parameter. This can be overridden using the timezone parameter per request. The date must be in ISO8601 format.
description: Start date time for report window. By default, the timezone for this parameter will be taken from the account settings for the account associated with the credentials used to make the request, or the account included in the Account parameter. This can be overridden using the timezone parameter per request. The date must be in ISO8601 format and may include precise time values (e.g., milliseconds).
type: string
example: "2022-12-12T00:00:00.000z"
example: "2022-12-12T01:01:01.001z"
end_date:
description: End date time for report window. By default, the timezone for this parameter
will be taken from the account settings for the account associated with the
credentials used to make the request, or the account included in the Account parameter.
This can be overridden using the timezone parameter per request. The date must be in ISO8601 format, and after the requested start_date.
This can be overridden using the timezone parameter per request. The date must be in ISO8601 format, and after the requested start_date and may include precise time values (e.g., milliseconds).
type: string
example: "2022-12-14T00:00:00.000z"
example: "2022-12-14T01:01:01.001z"
timezone:
description: The timezone of the messages to include, using the name of the region.
type: string
Expand Down Expand Up @@ -6443,11 +6458,27 @@ components:
description: Filter the report to only include messages that triggered an opt-out
type: string
example: "true"
channels:
# TODO: Update docs on 16/Oct/2026 once 13 months of data are available.
description: Filter the report by one or more message channels. Supported from 14/Aug/2025, and filtering by channels is available only for reports starting from this date.
type: array
items:
type: string
enum:
- SMS
- MMS
- TTS
- RCS
- WHATSAPP
- CHANNEL
example:
- SMS
- WHATSAPP
group_by:
description: Group results by a list of values, from the enumerable table above.
type: array
items:
$ref: '#/components/schemas/GroupByField'
$ref: '#/components/schemas/GroupByInsightField'
example:
- WEEK
- ACCOUNT
Expand Down Expand Up @@ -7403,6 +7434,21 @@ components:
type: string
description: The status of the message
example: enroute
RichMessageType:
title: RichMessageType
type: string
# TODO: Update docs on 16/Oct/2026 once 13 months of data are available.
description: The type of rich message. Supported from 09/Sep/2025, and this data is available only for reports starting from this date.
enum:
- TEXT_MESSAGE
- MEDIA_MESSAGE
- LOCATION_MESSAGE
- CHOICE_RESPONSE_MESSAGE
- MEDIA_CARD_MESSAGE
- CARD_MESSAGE
- CAROUSEL_MESSAGE
- CHOICE_MESSAGE
example: TEXT_MESSAGE
Message:
title: Message
required:
Expand Down Expand Up @@ -7548,6 +7594,8 @@ components:
type: number
description: The amount of messages received
example: 1
message_type:
$ref: '#/components/schemas/RichMessageType'
metadata:
type: object
description: >-
Expand Down Expand Up @@ -9499,6 +9547,24 @@ components:
- STATUS
type: string
example: DAY
GroupByInsightField:
title: GroupByInsightField
# TODO: Update docs on 16/Oct/2026 once 13 months of data are available.
description: Defines available fields for grouping insights reports. COUNTRY and CHANNEL are supported from 14/Aug/2025, and POSTBACK_DATA is supported from 16/Sep/2025, with data for these available only from those dates onward.
enum:
- ACCOUNT
- DAY
- WEEK
- MONTH
- YEAR
- METADATA_KEY
- METADATA_VALUE
- STATUS
- COUNTRY
- CHANNEL
- POSTBACK_DATA
type: string
example: DAY
CreateListRequest:
required:
- name
Expand Down