取得訊息分析數據

Get message analysis

post

Retrieve comprehensive bot message analytics and statistics across all platforms.

This endpoint provides:

  • Line platform statistics (quota, consumption, reply/push/broadcast amounts)

  • Multi-platform conversation analytics (average conversation values and times)

  • Platform integration status for all platforms Platforms covered: Line, Facebook, Instagram, LiveChat, WhatsApp

Authorizations
AuthorizationstringRequired

Bearer token for API authentication

Query parameters
botIdstringRequired

The bot ID for the API request

Body
secretstringRequired

Secret key for API authentication

Example: your_secret_key_here
Responses
chevron-right
200

Get Messages Analysis Successfully

application/json
successbooleanOptionalExample: true
messagestringOptionalExample: Get Messages Analysis Successfully
lineQuotaintegerOptional

Line platform quota limit

Example: 1000
lineQuotaConsumptionintegerOptional

Line platform quota consumption

Example: 250
lineReplyAmountsintegerOptional

Number of Line reply messages

Example: 45
linePushAmountsintegerOptional

Number of Line push messages

Example: 12
lineBroadcastAmountsintegerOptional

Number of Line broadcast messages

Example: 3
lineProgramstring · enumOptional

Line program data

Example: 輕用量Possible values:
lineAverageConversationValueintegerOptional

Average conversation value for Line platform

Example: 8
lineAverageConversationTimeintegerOptional

Average conversation time for Line platform (in seconds)

Example: 120
fbAverageConversationValueintegerOptional

Average conversation value for Facebook platform

Example: 6
fbAverageConversationTimeintegerOptional

Average conversation time for Facebook platform (in seconds)

Example: 95
igAverageConversationValueintegerOptional

Average conversation value for Instagram platform

Example: 4
igAverageConversationTimeintegerOptional

Average conversation time for Instagram platform (in seconds)

Example: 75
liveChatAverageConversationValueintegerOptional

Average conversation value for LiveChat platform

Example: 12
liveChatAverageConversationTimeintegerOptional

Average conversation time for LiveChat platform (in seconds)

Example: 180
whatsappAverageConversationValueintegerOptional

Average conversation value for WhatsApp platform

Example: 7
whatsappAverageConversationTimeintegerOptional

Average conversation time for WhatsApp platform (in seconds)

Example: 110
lineIsIntegrationbooleanOptional

Whether Line platform is integrated

Example: true
fbIsIntegrationbooleanOptional

Whether Facebook platform is integrated

Example: true
instagramIsIntegrationbooleanOptional

Whether Instagram platform is integrated

Example: false
liveChatIsIntegrationbooleanOptional

Whether LiveChat platform is integrated

Example: true
whatsappIsIntegrationbooleanOptional

Whether WhatsApp platform is integrated

Example: false
post
/openapi/message/analysis

Last updated