Get the email/newsletter channel analytics report

GET

/cms/analytics/email

const url = 'https://api.example.com/cms/analytics/email?unit=day&show_individual=false';
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/email?unit=day&show_individual=false' \
  --header 'API-Key: <API-Key>'

Returns accessible email/newsletter channels and a visits trend, scoped to the current admin’s allowed channels.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

date_from

string format: date

Defaults to 8 days ago.

date_to

string format: date

Defaults to today.

channel

Array<integer>

type

Array<string>

unit

string

default: day

Allowed values: day week month

show_individual

boolean

Responses

200

Accessible email/newsletter channels and visits trend

400

Invalid date range

401

Admin authorization required

403

Insufficient permissions