List the in-app messaging campaigns report

GET

/cms/analytics/messaging

const url = 'https://api.example.com/cms/analytics/messaging?unit=day';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.example.com/cms/analytics/messaging?unit=day' \
  --header 'API-Key: <API-Key>'

Authorizations

ApiKeyAuth

Parameters

Query Parameters

date_from

string format: date

Defaults to 8 days ago.

date_to

string format: date

Defaults to today.

unit

string

default: day

Allowed values: day week month

status

string

type

string

message

Array<integer>

Message ID(s) to filter by

Responses

200

Messaging campaigns summary, trend, and rollup table

400

Invalid date range

401

Admin authorization required

403

Insufficient permissions