Create Campaign Specific Report

Create a campaign-specific report for WhatsApp Business account. The projections field contains a comma-separated list of field names:

  • country_code: The country code of the recipient's phone number.
  • msisdn: The recipient's phone number.
  • message_type: The type of the message, such as text, image, and video.
  • message_payload: The content of the message.
  • request_id: The unique ID assigned to the message by the WhatsApp Business API.
  • conversation_id: The ID of the conversation thread.
  • message_id: The ID of the message.
  • submit_timestamp: The timestamp of when the message was submitted to the API.
  • sent_timestamp: The timestamp of when the message was sent to the recipient.
  • delivery_timestamp: The timestamp of when the message was delivered to the recipient.
  • read_timestamp: The timestamp of when the message was marked as read by the recipient.
  • failed_timestamp: The timestamp of when the message failed to be delivered.
  • deleted_timestamp: The timestamp of when the message was deleted.
  • extra: Additional information about the message.
  • pricing_model: The pricing model used for the message.
  • scheduled_time: The scheduled time of the message, if it was a scheduled message.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
required

An integer representing the maximum number of lines to include in the CSV file.

filters
object
required

An object containing the filters to apply to the report.

projections
array of strings
required

An array of strings representing the fields to include in the report.

projections*
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json