Skip to main content

Endpoint

GET https://api.apifycloud.io/api/v1/analytics/{appId}/messages

Authentication

Bearer token required. Scope: messages:read

Path parameters

  • appId (UUID, required)

Query parameters

  • limit (number, optional)
  • cursor (string, optional)
  • status (string, optional)
  • direction (string, optional) e.g. inbound, outbound
  • channel (string, optional) e.g. whatsapp
  • messageType (string, optional) provider message type
  • source (string, optional) connector source system
  • destination (string, optional) connector destination system
  • search (string, optional) matches user_phone, provider_message_id, conversation_key, provider_from, provider_to
  • startDate (string, optional) ISO date (YYYY-MM-DD)
  • endDate (string, optional) ISO date (YYYY-MM-DD)

Response

Errors

  • 403 forbidden unauthorized for app or missing scope
  • 400 validation_error invalid query parameters
  • 429 rate_limit_exceeded
  • 500 server_error

Example