GET/monitoring/message-contents/download

Downloads message content in CSV format.

This API operation requires the administrator or service account permissions.

To ensure service stability, this API operation limits concurrent requests. The server may reject any request that is made before the previous one has been completed.

Caution

  • If an error occurs during download, an error message is displayed after downloadLogs error at the end of the file.
  • Since the file download URL can be changed at any time, you need to make an API request to get the download URL every time you download the file.

Note

  • For how to download content using the API, see Upload or Download Files.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

monitoring.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/monitoring/message-contents/download

Query Parameters

ParameterTypeDescription
startTime string 

Start date from which you want to get monitoring data (YYYY-MM-DDThh:mm:ssTZD).
- The period between the start date and the end date must be within 31 days.
- 「+」 must be URL-encoded to 「%2B」.


required
example : 2025-05-01T00:00:00%2B09:00 
endTime string 

end date until which you want to get monitoring data (YYYY-MM-DDThh:mm:ssTZD).
- The period between the start date and the end date must be within 31 days.
- 「+」 must be URL-encoded to 「%2B」.


required
example : 2025-05-31T23:59:59%2B09:00 
language string 

The language of the CSV file


default : en_US
Allowed values : ko_KR, ja_JP, zh_CN, zh_TW, en_US 
botMessageFilterType string 

Specifies whether to include bot messages.
• include: Include • exclude: Exclude • only: Bot messages only


default : include
Allowed values : include, exclude, only 
domainId integer 

Domain ID
• Default: Domain ID of the account to get.


example : 10000001
format : int32 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 302

Returns the file access URL in the Location header.