v1

latestOpenAPI 3.0.12026-08-0640103344.9 KB

Reports

Get Inbound and Outbound Details

Generates a paginated report of all inbound and outbound message transmissions within a specified time frame (supports a maximum date range of up to 2 months). Supports granular filtering by targeted group IDs, specific transactional message types (such as Broadcast, TwoWay, OptInResponse, or KeywordResponse), and applies dynamic time zone offsets to accurately align historical delivery metrics.

post/reports/message-reports

Request body

groupIdsstring[]

An array of unique groupIds used to narrow down the message report metrics to specific subscriber groups.

messageTypesstring[]

An array of transactional message type categories to include in the report.

pageNumberinteger

Specifies the page index of the filtered reporting results to retrieve. Must be greater than or equal to 1.

pageSizeinteger

Controls the maximum number of log records returned per page response.

fromDatestring

The starting point of the reporting window formatted as a standard date string (YYYY-MM-DD). The total window spanned between 'fromDate' and 'toDate' must not exceed a maximum duration of 2 months.

toDatestring

The concluding endpoint of the reporting window formatted as a standard date string (YYYY-MM-DD). The total window spanned between 'fromDate' and 'toDate' must not exceed a maximum duration of 2 months.

timeZoneOffsetstring

The target numeric or string timezone displacement value used to accurately align historical UTC logs with your local business timeline metrics.

Response

Success

appCodestring nullable

messagestring nullable

isErrorboolean